Welcome to CS162 Habit Team's Final Project!

Let's Show You Around

To get the app running on your machine, complete the following steps:

1. Clone the repo and cd into it

git clone https://github.com/minerva-schools/cs162-habit.git && cd cs162-habit

2. Create / Activate Virtual Environment (requires python3 and virtualenv)

For Mac

python3 -m venv venv && source venv/bin/activate

For Windows

python3 -m venv venv && source venv/scripts/activate

3. Install dependencies

pip3 install -r requirements.txt

4. Run the app!

python3 -m flask run

Navigate to localhost:5000 and you should see a link to sign up and play around!

Running Tests

Unit Tests

To run the unit tests, complete the following steps:

1. Create / Activate Virtual Environment

For Mac

python3 -m venv venv_unit && source venv_unit/bin/activate

For Windows

python3 -m venv venv_unit && source venv_unit/scripts/activate

2. Install unit_test dependencies

pip3 install -r requirements-unit.txt

3. Run the unit tests

pytest unit_test

All tests should pass.

Integration Tests

Note: Make sure you have the local server up and running! Due to time constraints, no significant integration test development occurred.

To run the integration test, complete the following steps:

1. Create / Activate Virtual Environment

For Mac

python3 -m venv venv_integration && source venv_integration/bin/activate

For Windows

python3 -m venv venv_integration && source venv_integration/scripts/activate

2. Install integration_test dependencies

pip3 install -r requirements-integration.txt

3. Run the integration tests

pytest integration_test

All tests should pass.

Contributors

• Zane Sand: Team Lead / DevOps & Backend
• Tom Kremer: Backend
• Zineb Salimi: Backend
• Nour Elkhalawy: Design / Backend
• Nathan Torento: Frontend
• Vu Luong: Frontend