This Django web application allows you to extract and display README files from a GitHub user's account.
- Fetches repository data using the GitHub API
- Displays a list of repositories with links to view README files
- Renders README files as HTML with Markdown formatting
Check out the live demo of the application: https://github-repo-readme.onrender.com
-
Clone the repository:
git clone https://github.com/praTeek271/Github_repo___-README-.git cd Github_repo___-README-
-
Install dependencies:
pip install -r requirements.txt
-
Run the development server:
python manage.py runserver
-
Access the application in your browser at
http://127.0.0.1:8000/<github-username>/
- Enter a GitHub username in the URL to view the user's repositories and README files.
- Click on "View README" to see the rendered README file content.
- Django
- GitHub API
- Markdown
Include screenshots of your application in action here.
- Add user authentication for accessing private repositories
- Improve UI/UX with additional styling
- ...
Contributions are welcome! Fork the repository and create a pull request with your changes.
This project is licensed under the MIT License.