Creating a Dev Environment

Prerequisites

This project is written in Python using the Django Framework. This is a student project and will be maintained by new groups every year. This project must include rigorous documentation, tests, and adherence to conventions. We try to prioritize clear code over clever code and avoid third-party plug-ins whenever possible.

Tools

• Python
• pipenv (virtual environments)
• git (version control)
• VS Code

Setting up a Dev Environment

Step 0: Fork the Repo

If you plan on contributing to this project, you can fork the repo and make pull requests when you're ready to contribute.

Step 1: Clone the Repo Locally

• Open up a terminal then navigate to your preferred directory
• Run git clone https://github.com/worcestertechnicalhighschool/hallpass.git
• Run cd ./hallpass
• Run code . to open VSCode in the current directory

Step 2: Setup your virtual environment

• Run pip3 install pipenv
• Run python3 -m pipenv install

Step 3: Setup the server

• python3 -m pipenv shell (do this every time you want to run the server)
• cd ./hallpass
• python3 manage.py make-migrations
• python3 manage.py migrate

Step 4: Setup the Social-Auth (Google)

• python3 manage.py initsocialapp Answer the prompts to proceed

Step 5: Run the server

• python3 manage.py runserver