Running

To run the application on a local machine, you will need to setup a Python 3 virtual environment and run it through there.

If you don't have the repository already, run git clone https://github.com/park-junha/PlanForGrad. Info on Git installation here.

If you are running the master copy of the app, make sure your master is up to date: git checkout master && git pull. You don't need to run this if you just cloned the repository.

You will need Python3 and Pip3. If you don't have them, read this to install.

macOS / Linux

Setting up the virtual environment

1. Run mkdir ~/.virtualenv to make a folder for your environment in your Home directory.
2. Run python3 -m venv ~/.virtualenv/PlanForGrad to make the virtual environment. You don't have to name it PlanForGrad.
3. Active it with source ~/.virtualenv/PlanForGrad/bin/activate.
4. Navigate to your local repository. (cd <path-to-repository>)
5. Run pip3 install -r requirements.txt to install Python dependencies to the virtual environment.

Running the web app

1. Activate your virtual environment with source ~/.virtualenv/PlanForGrad/bin/activate. If you haven't yet created it, see below section.
2. Navigate to your local repository. (cd <path-to-repository>)
3. Run python3 main.py <password-to-database>. Ask jpark3@scu.edu for the password.
4. Open your browser and navigate to localhost:5000 on your web browser to access the frontend.

Windows 10

1. Install Python.
2. Navigate to your local repository. (cd <path-to-repository>)
3. Run python main.py <password-to-database>. Ask jpark3@scu.edu for the password.
4. Open your browser and navigate to localhost:5000 on your web browser to access the frontend.