Skip to content

AlexaBrett/MLA-pilot

 
 

Repository files navigation

MLA Fitness App

A simple and interactive fitness tracking application built with multiple microservices and programming languages. This application allows users to track their exercises and monitor their progress over time.

The Activity Tracking functionality uses the MERN stack (MongoDB, Express.js, React, Node.js), the Analytics service uses Python/Flask and the Authentication Microservice using Java.

Screenshot

Current Features

  • User registration for personalized tracking
  • Log various types of exercises with descriptions, duration, and date
  • See weekly and overall statistics
  • Interactive UI with Material-UI components
  • Real-time data persistence with MongoDB

Prerequisites

  • Node.js
  • MongoDB
  • npm or yarn
  • Python Flask
  • Java 8 (all already installed in the devcontainer)

Development in Github Codespaces

Starting a new Devcontainer

  1. Click on "Code"

  2. Switch to the "Codespaces" tab

  3. Create new Codespace from main

  4. Open Codespace in VS code for best experience:

Walktrough:

https://docs.github.com/en/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code

Check needed packages are installed:

sh .devcontainer/check-installation.sh

expected output:

Checking installations...
node is /usr/local/bin/node
node is installed with version: v18.16.0
npm is /usr/local/bin/npm
npm is installed with version: 9.5.1
python3 is /usr/bin/python3
python3 is installed with version: Python 3.9.2
pip3 is /usr/bin/pip3
pip3 is installed with version: pip 20.3.4 from /usr/lib/python3/dist-packages/pip (python 3.9)
gradle is /usr/bin/gradle
gradle is installed with version:
------------------------------------------------------------
Gradle 4.4.1
------------------------------------------------------------
......
Done checking installations.

if you're missing any version, please contact your course administrator.

Building entire project with Docker (+ starting containers up)

docker compose up --build

Start existing containers (no rebuild of images)

docker compose up

Spinning up a single service

docker compose up [servicename]

Shutting down a service

docker compose down [servicename]

Docker Prune (complete refresh)

docker system prune --all --force --volumes

Development without using Docker-Compose

Running Node.js Activity Tracker

cd activity-tracking
npm install
nodemon server

Running Flask application

cd analytics
flask run -h localhost -p 5050

Running Java application

cd authservice
./gradlew clean build
./gradlew bootRun

Start the Frontend

cd frontend
npm install
npm start

spin up MongoDB without docker-compose:

docker run --name mongodb -d -p 27017:27017 -v mongodbdata:/data/db mongo:latest

Connect to MongoDB

mongosh -u root -p cfgmla23 --authenticationDatabase admin --host localhost --port 27017

show registered activities:

db.exercises.find()

show registered users:

db.users.find()

Deployment

The application is containerized using Docker and can be deployed on any platform that supports Docker containers. For AWS deployment, a GitHub Actions pipeline is configured for CI/CD.

Tyk

By default, the services are run behind Tyk (used as an API Gateway & Reverse Proxy). Tyk is configured in the ./tyk folder, where each api has a config file (eg tyk/apps/auth). Here we configure which requests to tyk we match to this api, where we forward them on to and any middleware that is applied.

To access TYK, the frontend/orchestration needs to use an API Key. This is set as TYK_API_KEY in the .env for the frontend, and is set as a header on all requests to tyk. This means that all requests to our services are fully secured through auth, as requests can only get to the service via tyk, and the only way to get the api key is to send a request to the frontend/orchestration with a valid auth token.

If Tyk is giving errors in the logs like connect: connection refused, you may need to generate a new api key and place it in the env file for the frontend. To do this, copy the cUrl command in the tyk folder and run it in your terminal. Paste the value of the "key" output into your .env.local file as the TYK_API_KEY, and this will give the next.js orch the authentication to hit the services through tyk.

. tyk/curl_command

Grafana & Prometheus

All services and the frontend send metrics to Prometheus, and are displayed on a Grafana dashboard. The dashboard is stored as a json file in the grafana folder for easy local development.

About

Group 6 Mid Level Accelerator content repository

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 47.4%
  • Python 18.8%
  • JavaScript 13.6%
  • Java 8.3%
  • CSS 6.0%
  • HTML 2.3%
  • Other 3.6%