SecFit

SecFit (Secure Fitness) is a hybrid mobile application for fitness logging.

Deploy with Docker

Prerequisites:

Docker

Git

Windows hosts must use Education or more advanced versions to run Docker
Download: https://innsida.ntnu.no/wiki/-/wiki/English/Microsoft+Windows+10

Install:

$ git clone https://gitlab.stud.idi.ntnu.no/kyleo/secfit.git
$ cd secfit/

Run:

$ docker-compose up --build
Hosts the application on http://localhost:9090 with default settings

Technology

• deployment Docker
• web Nginx
• database Postgre SQL
• backend Django 3 with Django REST framework
• application
  • browser - HTML5/CSS/JS, Bootstrap v5 (no jQuery dependency)
  • mobile Apache Cordova (uses same website)
• authentication JWT

Code and structure

.gitlab-ci.yml - gitlab ci requirements.txt - Python requirements package.json - Some node.js requirements, this is needed for cordova

• secfit/ django project folder containing the project modules
  • <application_name>/ - generic structure of a django application
    • admins.py - file contaning definitions to connect models to the django admin panel
    • urls.py - contains mapping between urls and views
    • models.py - contains data models
    • permissions.py - contains custom permissions that govern access
    • serializers.py - contains serializer definitions for sending data between backend and frontend
    • parsers.py - contains custom parsers for parsing the body of HTTP requests
    • tests/ - contains tests for the module. View Testing in Django for more.
    • views.py - Controller in MVC. Methods for rendering and accepting user data
    • forms.py - definitions of forms. Used to render html forms and verify user input
    • settings.py - Contains important settings at the application and/or project level
    • Procfile - Procfile for backend heroku deployment
  • media/ - directory for file uploads (need to commit it for heroku)
  • comments/ - application handling user comments and reactions
  • secfit/ - The projects main module containing project-level settings.
  • users/ - application handling users and requests
  • workouts/ - application handling exercises and workouts
  • manage.py - entry point for running the project.
  • seed.json - contains seed data for the project to get it up and running quickly (coming soon)

Local setup

It's recommended to have a look at: https://www.djangoproject.com/start/ Just as important is the Django REST guide: https://www.django-rest-framework.org/

Create a virtualenv https://docs.python-guide.org/dev/virtualenvs/

Django

Installation with examples for Ubuntu. Windows and OSX is mostly the same

Fork the project and clone it to your machine.

Setup and activation of virtualenv (env that prevents python packages from being installed globaly on the machine)

Naviagate into the project folder, and create your own virtual environment

Install python requirements

pip install -r requirements.txt

Migrate database

python manage.py migrate

Create superuser

Create a local admin user by entering the following command:

python manage.py createsuperuser

Only username and password is required

Start the app

python manage.py runserver

Add initial data

You can add initial data either by going to the url the app is running on locally and adding /admin to the url.

Add some categories and you should be all set.

Or by entering

python manage.py loaddata seed.json

Cordova

Cordova CLI guide: https://cordova.apache.org/docs/en/latest/guide/cli/ If you want to run this as a mobile application

• Navigate to the frontend directory
• For android, do cordova run android
• For ios, do cordova run ios
• For browser, do cordova run browser

It's possible you will need to add the platforms you want to run and build. The following documentation can be used to run the application in an Android emulator:
https://cordova.apache.org/docs/en/latest/guide/platforms/android/index.html