-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
make the contents more verbose
- Loading branch information
Showing
1 changed file
with
34 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,35 @@ | ||
# Small Git Web Repository Viewer | ||
# SmallGitWebRepoView | ||
|
||
python3 -m venv venv | ||
source venv/bin/activate | ||
pip install -r requirements.txt | ||
python3 <path to repository to read> | ||
The Git Repository Viewer is a powerful and intuitive Flask web application that provides a comprehensive web interface for exploring Git repositories. This project showcases the seamless integration of Flask with GitPython, allowing users to effortlessly navigate through a repository's files and commit history. | ||
|
||
## Features | ||
|
||
- **File List**: The application presents a clean and organized list of files within the repository, allowing users to easily browse and access each file. | ||
|
||
- **Commit History**: Gain insights into the commit history of the repository with an interactive display of commit details, including the commit message, author, and timestamp. | ||
|
||
- **File Content**: Clicking on a file in the file list reveals the file's content, enabling users to conveniently view the text within the web application itself. | ||
|
||
- **Customizable Styling**: The web interface is styled using CSS to ensure a visually appealing experience. It employs a bold monospace font to enhance readability and provide a professional look and feel. | ||
|
||
## Usage | ||
|
||
To get started with the Git Repository Viewer, follow these simple steps: | ||
|
||
1. Install the necessary dependencies by running `pip install -r requirements.txt`. | ||
|
||
2. Execute the Flask application by running `python viewer.py <repository_path>`, where `<repository_path>` is the path to your desired Git repository. | ||
|
||
3. Open a web browser and access the application at `http://localhost:5000`. You will be presented with an intuitive interface showcasing the files and commit history of the repository. | ||
|
||
4. Explore the files, view commit details, and even inspect the content of individual files by clicking on the appropriate links. | ||
|
||
## Contributions | ||
|
||
Contributions to the Git Repository Viewer project are highly welcomed! If you have any ideas, suggestions, or bug fixes, please feel free to submit a pull request. Together, we can enhance this proof of concept application and make it even more valuable to the Git community. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. Feel free to use, modify, and distribute it as per the terms of the license. | ||
|
||
Let's embark on this exciting journey of exploring Git repositories with the Git Repository Viewer! |