imankassim / calorie_tracker

calorie_tracker

This is a Calorie Tracker system you can use to calculate how many calories you have had in a day. This can be accessed here: http://35.242.139.215:5000/login (until July 2022)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Software needed:

• An IDE (I used VS Code)

• Linux BASH Terminal

• Jenkins

Installing (with Jenkins)

• Fork and then clone this GitHub repo onto your terminal/host - You can host this application anywhere, including with Google Cloud Platform, with GUnicorn, with Nginx or even locally within your IDE
• Install Jenkins onto your terminal/host and configure the Jenkins setup
• On your Forked version of the repo, configure your GitHub webhook to build in Jenkins when a change to the code is committed
• Configure your Jenkins Job with your repo details to access the application straight from GitHub:
  • In Build, enter the following code:

   #!/bin/bash
   sudo cp /home/jenkins/.jenkins/workspace/calorietracker/flaskapp.service /etc/systemd/system/flaskapp.service
   sudo systemctl daemon-reload
   sudo systemctl start flaskapp.service
  

Installing (Only using IDE - linux terminal)

• Clone this GitHub repo onto your terminal/host
• Install the following onto your terminal/host:

   sudo apt update
   sudo apt install python3 python3-pip python3-venv
  

• Set up your local virtual machine:

   python3 -m venv venv
   source venv/bin/activate
  

• Install the required libraries:

   pip3 install -r requirements.txt
  

• Set up the test data in the database:

   python3 create.py
  

• To run the application:

   python3 app.py
  

Tests

Unit tests are used with form validators to ensure the right data is entering and leaving the app and database

Running the tests

• Clone this repository into your IDE
• Install the following onto your terminal/host:

   sudo apt update
   sudo apt install python3 python3-pip python3-venv
  

• Set up your local virtual machine:

   python3 -m venv venv
   source venv/bin/activate
  

• Install the required libraries:

   pip3 install -r requirements.txt
  

• To run the tests:

   python3 -m pytest --cov -report term_missing --cov= application tests
  

Built With

• Python - Programming Language
• Flask - Web application framework
• GCP VM Instance - Cloud hosted Virtual Machine
• pytest - Testing with Python
• jenkins - CI server

Authors

• Iman Kassim

License

This project is licensed under the MIT license