Woodog:dog: is an initiative to provide help to increasing stray animals by providing them food :bread: and refuge :house: by connecting them with fellow helpful humans. On the application, two types of people can be registered :inbox_tray: one who can provide the location and condition of a nearby stray, and another who can provide information and arrange shelter :house: and food :bread: for them.
Django and bootstrap are incorporated into the application, requiring authentication and establishing profiles and positioning using maps.
Step 1: Downloading and Installing the Code Editor
You can download and install any one of the following IDE.
- Visual Studio Code (Preferred)
- Sublime Text 3
- Atom
Step 2: Installing Python
Download Python Latest Version
- Make sure to check 'Add Python to Path' in the setup window of the Installer.
Verify the installation from the Terminal using the following command,
python --version
Step 5: Cloning Repository using Git
git clone https://github.com/'<your-github-username>'/Woodog.gitStep 6: Change directory to Woodog
cd WoodogStep 7: Add reference to the original repository
git remote add upstream https://github.com/Feminine-Divine/Woodog.gitStep 8: Creating Virtual Environment
Install virtualenv
pip install virtualenvCreating Virtual Environment named env
virtualenv envTo Activate env
source env/Scripts/activate
or
./env/Scripts/activateTo deactivate env
deactivateStep 9: Installing Requirements
Note: Before installing requirements, Make sure the virtual environment is activated.
cd Woodog
pip install -r requirements.txtStep 10: Making database migrations
Note: Before making database migrations, make sure you've successfully created database.
python manage.py makemigrationspython manage.py migrateStep 11: Creating superuser to access Admin Panel
python manage.py createsuperuserStep 12: Running the Project in local server
Note: Before running the project in local server, Make sure you activate the Virtual Environment.
python manage.py runserverServer will be up and running in local host on PORT 8000
1️⃣ Always keep updating your master branch with the main repository by running the following command on the local master branch. Refer this stackoverflow page.
git pull upstream master2️⃣ Always create a new branch before making any changes. Never ever make any changes directly on the master branch. To create a new branch,
git checkout -b '<new-branch-name>'- Please take a moment to review the Code of Conduct and contributing.md which provides the guidelines for contributing.
- Fork the project.
- Create your Feature Branch
git checkout -b '<your_branch_name>'- Stage your changes
git add .- Commit your changes
git commit -m '<your_commit_message>'- Check for Status to be sure everything is added
git status- Check for your remote
git remote -v- Push changes to remote
git push origin '<your_branch_name>'- Open a Pull Request
|
 |  |
