Uses the GitHub API to retrieve the most starred public Python projects. Stores the list of repositories in a SQL database table with their respective repository ID, name, URL, created date, last push date, description, and number of stars.
Built With
- Django
- Tailwind CSS
To get a local copy up and running, please follow these simple steps.
Pre-requisites
-
Create a virtual environment
python -m venv top_starred_env -
Enter the environment
cd top_starred_env -
Activate the environment Windows:
Scripts\activateMac:source bin/activate -
Copy src Folder in to your new environment folder Click here to download OR
git clone https://github.com/ayazamlani/top_starred_python_projects.git
- Enter the src directory
cd top_starred_python_projects
Installation
-
Install all of the necessary libraries
pip install -r requirements.txt -
Enter the project
cd python_projects -
Create the SQL DB
python manage.py migrate
-
Start the dev server!
python manage.py runserver -
In your browser, navigate to http://localhost:8000
Configuration
To change the number of results per page, Enter the main app folder and edit the settings .py file.
cd python_projects
At the bottom of settings .py change the GITHUB_REPOSITORY_RESULTS_PER_PAGE variable
To check out the admin panel, stop the dev server and run the following command and go through the super user setup
python manage.py createsuperuser
Now restart the dev server
python manage.py runserver
Navigate to http://localhost:8000/admin/ to play with the admin dash