Skip to content

software-students-spring2024/5-final-project-spring-2024-dttt5

Repository files navigation

app_ci ci event-logger

Final Project

An exercise to put to practice software development teamwork, subsystem communication, containers, deployment, and CI/CD pipelines. See instructions for details.

Team members

Deniz Qian: https://github.com/dq2024
Somyung Kim: https://github.com/troy-skim
Terrance Chen: https://github.com/tchen0125
Kim Young: https://github.com/Kyoung655

Project Description

This project is a fitness journal app that helps users manage their weight loss by allowing them to log meals, workouts, and track their weight goals. Users can see the calorie deficit needed to reach their desired weight through a simple, user-friendly interface.

Project Instructions

System Requirements

  • Python 3.9 or higher

Run the Application

1. Initialize

Enter in your browser: http://104.236.9.46:8080/

2. Login / Register

Click Register Here button to register. Enter username and password, and click login.

3. Main Page

You can see your calorie status, logout, set your weight goals, add calorie and workout entries.

4. Set Your Weight Goals (Optional)

You can set your weight goals to check total calorie deficit needed to reach the target weight. The value is calculated with your current and target weight. (Note: Only for this feature will you need to refresh the page to see it update)

5. Add Calorie Entries

You can add your previous meals. Enter food, calorie, date, and click Add Food button. The entires will show in the calorie entries table where you can edit or delete the entries.

6. Add Workout Entries

You can add your workouts. Enter workout name, calorie, date and click Add Workout button. The entries will show in the workout entries table where you can edit or delete the entries.

Run the Application (locally)

Dependencies should be automatically installed.
If not:

pip install flask pymongo python-dotenv pytest pytest-flask Werkzeug pytest-mock pytest-cov

Enter in your terminal:

docker compose up --build

Shutdown the Application (locally)

Enter in your terminal:

docker-compose down

Unit Test Coverage

Unit test coverage should already be displayed automatically. If it doesn't, from the root dir, please run:

pytest --cov=./

Link to Dockerhub Container Images

Link to dockerhub

About

5-final-project-spring-2024-dttt5 created by GitHub Classroom

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published