From 8f0ee21ed039b0948be079d7645e55d8856e3a90 Mon Sep 17 00:00:00 2001 From: Kumi Date: Wed, 19 Jun 2024 11:53:10 +0200 Subject: [PATCH] feat: add repository cloning instructions in README Includes instructions for cloning repositories using the git client over HTTP(S) in the README. Updated project version to 0.0.6 to reflect these changes. Minor formatting improvements in index.html to enhance readability. --- README.md | 7 ++++ pyproject.toml | 2 +- src/gitcloak/templates/index.html | 57 +++++++++++++++++++++---------- 3 files changed, 47 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f1f7893..3ea1149 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Instead of using the GitHub API or screen scraping, GitCloak interfaces directly - Browse directories and files in GitHub repositories. - View the content of files directly in the browser. - Responsive design with Bootstrap for a clean and professional look. +- Cloning repositories using the git client over HTTP(S). ## Getting Started @@ -110,6 +111,12 @@ GitCloak currently supports the following environment variables: http://localhost:8107///raw/main/ ``` +- **Clone Repository**: To clone a repository using your git client, just do as you would normally do: + + ```sh + git clone http://localhost:8107// + ``` + ## Contributing We welcome contributions to improve GitCloak! To contribute: diff --git a/pyproject.toml b/pyproject.toml index a5160bf..444fff3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "gitcloak" -version = "0.0.5" +version = "0.0.6" authors = [{ name = "Private.coffee Team", email = "support@private.coffee" }] description = "Simple Python-based private frontend for GitHub repositories" readme = "README.md" diff --git a/src/gitcloak/templates/index.html b/src/gitcloak/templates/index.html index 31953a2..401f995 100644 --- a/src/gitcloak/templates/index.html +++ b/src/gitcloak/templates/index.html @@ -1,20 +1,41 @@ -{% extends 'base.html' %} - -{% block title %}Welcome to GitCloak{% endblock %} - -{% block content %} +{% extends 'base.html' %} {% block title %}Welcome to GitCloak{% endblock %} {% +block content %}
-

Welcome to GitCloak!

-

GitCloak is a simple web frontend that lets you browse public GitHub repositories and view their contents.

-

Unlike other GitHub interfaces, GitCloak does not use APIs or screen scraping, needs no credentials and does not use any JavaScript.

-
-

To get started, simply replace github.com in the URL - the following paths are already available:

-
    -
  • /<owner>/<repo>/ - View the root directory of the repository
    • -
  • /<owner>/<repo>/tree/main/<path> - View a specific directory
    • -
  • /<owner>/<repo>/raw/main/<file_path> - View the raw content of a specific file
    • -
-

For example, to see the contents of the PrivateCoffee/transfer.coffee repository, simply visit /PrivateCoffee/transfer.coffee/.

-

Other features are still in development, so stay tuned!

+

Welcome to GitCloak!

+

+ GitCloak is a simple web frontend that lets you browse public GitHub + repositories and view their contents. +

+

+ Unlike other GitHub interfaces, GitCloak does not use APIs or screen + scraping, allows cloning repositories, needs no credentials and does not use + any JavaScript. +

+
+

+ To get started, simply replace github.com in the URL - the + following paths are already available: +

+
    +
  • + /<owner>/<repo>/ - View the root directory of the + repository +
    • +
  • + /<owner>/<repo>/tree/main/<path> - View a + specific directory +
    • +
  • + /<owner>/<repo>/raw/main/<file_path> - View + the raw content of a specific file +
    • +
+

+ For example, to see the contents of the + PrivateCoffee/transfer.coffee repository, simply visit + /PrivateCoffee/transfer.coffee/. +

+

Other features are still in development, so stay tuned!

-{% endblock %} \ No newline at end of file +{% endblock %}