You are Awesome! Thank you for your Interest in Contributing to this Project 🤗 For Contributions we strictly follow Github Flow.
-
The Project works seamlessly on Python version
3.8.6 -
Fork the Repository
-
Clone Your Forked copy -
git clone https://github.com/[YOUR-USERNAME]/Kitabe.git -
Navigate to the directory of project -
cd Kitabe/ -
Create a new branch -
git checkout -b [branch_name] -
If you don't have virtualenv already installed -
pip install virtualenv -
Create a new environment -
virtualenv bookenv -
Activate the environment -
- For Linux/Unix OS :
source bookenv/bin/activate - For Windows OS:
bookenv\Scripts\activate
- For Linux/Unix OS :
-
Install requirements -
pip install -r requirements.txt -
Open
BookRecSystem/settings.py -
Set
SECRET_KEY = "RANDOM_KEY" -
Set
ALLOWED_HOSTS = ['kitabe-app.herokuapp.com', '127.0.0.1', 'localhost'] -
Make Migrations -
python manage.py migrate -
python manage.py runserver- You're good to Go!!
-
Please go through Github Flow, if not already. :)
-
Discuss your proposed changes & Get assigned.
-
If your changes are approved, do the changes in branch
[branch_name]. -
Run tests
-
flake8,python manage.py test -
Fix if any test fails.
-
Still in branch
[branch_name]. -
Stage and Commit only the required files.
-
git push origin [branch_name] -u -
Browse here and create a PR from your branch with the appropriate required details.
-
If your PR is accepted, it is automatically deployed once merged. :)
-
That's it!
Tip: To keep your Fork Repo all branches updated with Upstream use this.