TigerPath

TigerPath is a web app that helps Princeton University students plan out their four-year course schedules. It began as a COS 333 project by Richard Chu, Barak Nehoran, Adeniji Ogunlana, and Daniel Leung.

You can visit TigerPath at tigerpath.io.

To learn about contributing to TigerPath, take a look at the contributing guidelines.

Setup

Pipenv

1. git clone this repository. Install Python 3.6, node.js, and pipenv (which helps you manage your dependencies).

2. Run cd tigerpath && pipenv install to install all of the current dependencies from Pipfile.lock.

3. Run cd frontend && npm install to install the necessary node modules for React to work.

4. Run cd .. && cp .env-example .env. Then, set the environment variables in your .env file; specifically, you should replace the value of DATABASE_URL with the proper database URL for your Postgres server. You should also fill in the TIGERBOOK_USERNAME and TIGERBOOK_API_KEY fields if you want the prepopulation of the user's year and major in the onboarding flow to work (you can get a TigerBook API key by following the instructions here).

5. You can start a server with the environment variables in the file .env by running pipenv run python manage.py runserver. For development, run the webpack server (React) along with the Django server by calling npm start in the folder "frontend". Then you can navigate to http://localhost:8000/ to see the app.

Docker Community Edition

Note: this installation method is not recommended because you have to re-build and re-run for every change you make.

1. git clone this repository. cd into the directory you just cloned.

2. Install the Docker Community Edition. Make sure you also have Docker Compose installed (should be automatically installed on Windows and Mac).

3. Run cp .env-example .env. Then, set the environment variables in your .env file; specifically, you should replace the value of DATABASE_URL with the proper database URL for your Postgres server. You should also fill in the TIGERBOOK_USERNAME and TIGERBOOK_API_KEY fields if you want the prepopulation of the user's year and major in the onboarding flow to work (you can get a TigerBook API key by following the instructions here).

4. Use the following commands to build your project and run it on a local server:

   docker-compose build                                    # Build code changes
   docker-compose up                                       # Run a local server at http://localhost:8000
   docker-compose down                                     # Stop the server
   

Development

If you're using pipenv and you want to run one of the following commands, you should prefix it with pipenv run to make sure you're using the settings in your .env file. You can also run pipenv shell, which allows you to run the commands directly without prefixing.

If you're using Docker, then you can run any of the following commands by using docker exec -it [CONTAINER_NAME_OR_ID] [YOUR_COMMAND].

Make migrations and update database

You can do this by running the following commands:

python manage.py makemigrations                             # Makes migrations based on models.py
python manage.py migrate                                    # Migrates the database

If you're using Docker, then once you make the migration files, you should copy them from the container to the host (your local computer) by running docker cp <containerId>:/file/path/within/container /host/path/target. You should then push the migration files to Git.

Custom django-admin commands

python manage.py tigerpath_get_courses                      # Scrapes courses and puts them in the database

Load static data

To load the major mappings fixture, which populates the major table in the database, run the following command:

python manage.py loaddata major_mappings

Deployment

Heroku deploys are set up to happen automatically based on the code in GitHub. You shouldn't need to deploy manually.

However, in the rare case that you do, then you can run the following command:

git push heroku <local_branch_name>:master                    # Push to the Heroku server