Skip to content

payaldutta/Woodog

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Woodog

We could see the innocence livings in our day to day life, that includes stray dogs who suffers the most by not having a perfect family or living to survive. We all should help these dogs by the means of giving them shelter, food, protection to have their loyality. So this Application to aid and provide refuge for stray animals and dogs by connecting them and helpful people. On the application, two types of people can be registered: one who can provide the location and condition of a nearby stray, and another who can provide information and arrange shelter and food for them. Django and bootstrap are incorporated into the application, requiring authentication and establishing profiles and positioning using maps.

Instructions to setup

Step 1: Downloading and Installing the Code Editor
You can download and install any one of the following code editors.


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 3: Installing Git
Download Git

Step 4: Fork the Repository
Click on to fork this repsository

Step 5: Cloning Repository using Git
git clone https://github.com/'<your-github-username>'/Woodog.git

Step 6: Change directory to Woodog
cd Woodog

Step 7: Add reference to the original repository
git remote add upstream https://github.com/Feminine-Divine/Woodog.git

Step 8: Creating Virtual Environment
Install virtualenv

pip install virtualenv

Creating Virtual Environment named env

virtualenv env

To Activate env

source env/Scripts/activate

To deactivate env

deactivate

Step 9: Installing Requirements

Note: Before installing requirements, Make sure the virtual environment is activated.

pip install -r requirements.txt

Step 10: Download and Install postgreSQL
  • Download postgreSQL
  • Install it.
  • Add postgreSQL to path.

Step 11: Create Database named 'woodog'

To create database in postgreSQL,

createdb --username=postgres woodog

Step 12: Making database migrations

Note: Before making database migrations, make sure you've successfully created database.

python manage.py makemigrations
python manage.py migrate

Step 13: Creating superuser to access Admin Panel
python manage.py createsuperuser

Step 14: Running the Project in local server
Note: Before running the project in local server, Make sure you activate the Virtual Environment.

python manage.py runserver

💡 Pro Tip!

  • 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 master
  • 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>'

Code of conduct


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>'
  • Push changes to remote
git push origin '<your_branch_name>'

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 35.6%
  • HTML 28.2%
  • JavaScript 18.8%
  • CSS 17.4%