phit-test

(Reference) How I started a new project

This is just to keep a record of what steps I took to create the overall structure of our project. These steps could be followed when you want to start a completely new project for any reason. If you are looking for instructions to open an existing project on your own computer, start reading from the next section "Initial Setup".

I cd-ed into the directory where I cloned the repository and activated the virtual environment. Then I made sure all the dependencies were installed. Then I ran django-admin startproject phittest to create the project. Then, I cd into the project, and ran python manage.py startapp accounts to create an accounts app within the project.

Initial Setup

Only do these steps if this is your first time working on the project.

Set up the virtual environment

First, install virtual environment if you do not have one. To install, run pip install virtualenv.

Cd into the directory that you have cloned the repository to. Then, you can set up a virtual environment by running virtualenv venv. This will create a virtual environment named "venv".

To start (activate) the virtual environment, which you hae to do before you start working on the project or following through the next steps, run source venv/bin/activate.

To leave (deactivate) the virtual environment, run deactivate.

Dependencies

Activate virtual environment and run the following command to install all dependencies as outlined in requirements.txt. Run python -m pip install -r requirements.txt

Setting up Django Admin

Then cd into phittestv1. Run python manage.py migrate. Then run python manage.py createsuperuser to create an admin account to log into Django Admin Dashboard. The username could be anything that you choose, and it could be set differently for each member of the group. However, I used "admin" for both the username and password. When it asks for the email, you can skip by pressing an "enter" on your keyboard. If you use a short password, it will warn you, but just respond "y" and you can still create an account.

Running the website locally

Make sure you have cd-ed into phittestv1. Then run python manage.py runserver. To quit the server, press control+C.