Information

Deploy

We have set up CI/CD in GitLab, see the pipelines page and the .gitlab-ci.yml files in the different folders for specifications. We are deploying the backend to Heroku and the frontend to Firebase.

Testing

Testing backend (Django)

Start in project root. (Assumes Windows and previously set up virtual environment in venv-folder.)

• Run cd backend\secfit
• Run venv\Scripts\activate
• run python manage.py test
• Profit

Testing frontend (Cypress)

Start in project root. (Assumes Windows and previous npm install run in frontend folder.)

• Run backend with python manage.py runserver in .\backend\secfit in a virtual environment. Url: http://localhost:8000
• Serve the frontend with serve from .\frontend\www. Url: http://localhost:5000
• Run cd frontend
• Run npm run test to open up Cypress.
• Select relevant test suite from list in Cypress.

Where to find which tests

Here is the path to the tests we have written.

• Task 2
  • UserSerializer - .\backend\secfit\users\tests\user_serializer.py
  • Permissions - .\backend\secfit\workouts\tests\permissions.py
• Task 3
  • Boundary value tests
    • User registration - .\backend\secfit\users\tests\user_registration.py
    • Workout page - .\frontend\cypress\integration\workout-boundary-test.spec.js
  • 2-way domain tests
    • User registration - at the bottom of .\backend\secfit\users\tests\user_registration.py
  • Tests of new features
    • Integration tests
      • Athlete group - .\backend\secfit\users\tests\athlete_group.py
      • Update user, used in profile page - .\backend\secfit\users\tests\update_user.py
    • System tests
      • Athlete group, user profile and graphs - .\frontend\cypress\integration\secfit-test.spec.js
  • FR5
    • Visibility - .\backend\secfit\workouts\tests\visibility.py

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)
• authentication JWT

Code and structure

.gitlab-ci.yml - gitlab ci requirements.txt - Python requirements

• 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