Skip to content

Technical Installation Manual

Jump to bottom
Luqmaan Abram edited this page Jul 31, 2023 · 50 revisions

Introduction

  • This document serves as a technical installation manual describing all the installation guidelines, prerequisites and deployment of the SweatSession application, in order for the user to be able to run the application locally.
  • The SweatSession app was developed as a social, location-based mobile app that will enable users to schedule workout sessions with their friends, track their progress, view their friends' personal bests, and earn rewards for achieving their fitness goals.
  • In order for the user to run the SweatSession application, software such as Ionic , Angular and Node.js would have to be installed and configured.

Configuration Prerequisites

Recommended Hardware

Specific Computer Hardeware Minimum Requirements
CPU Intel i5 / AMD Ryzen5
Memory 8GB (or higher)
Storage 5GB Free Space

Backend

Node.js :version 16+

Installation Steps For Windows

  1. Open your web browser

  2. Go to the Node.js website: Node.js/website

  3. Choose the LTS version

  4. Download the Windows installer for the 64bit version

  5. Run the installer

Installation Steps For Linux

  1. Open the terminal

  2. Run the following command: sudo apt install nodejs

Installation Steps For Mac

  1. Open your web browser

  2. Go to the Node.js website: Node.js/website

  3. Choose the LTS version

  4. Download the macOS installer for the 64bit version

  5. Run the installer

Verification

Verify the installation by executing node -v

Yarn Installation

Installation Steps For Windows

  1. Open terminal

  2. Run the command: npm install --global yarn

Installation Steps For Linux

  1. Open the terminal

  2. Run the command: sudo apt install --no-install-recommends yarn

Installation Steps For Mac

  1. Open terminal

  2. Run the command: brew install yarn

Verification

Verify the installation by executing yarn --version

Frontend

Angular :version 16

Installation Steps For All Operating Systems

  1. Open the terminal

  2. Run the following command: npm install -g @angular/cli

Verification

Verify the installation by executing ng version


Ionic :version 7.1+

Installation Steps For All Operating Systems

  1. Open the terminal

  2. Run the following command: npm install -g @ionic/cli

Verification

Verify the installation by executing ionic -v


Firestore Database

  1. Add Firebase Project

    • Go to Firebase Console, login with your Google Account, then click on Add Project.


  1. Enter Project name, set Project Id and click on Continue.


  1. Register App and get Firebase SDK.
  • Now browser turns into following view:


  1. Click on Web App, screen will display:


  1. Set the nickname and choose Register App to proceed to the next step.


  1. Open the terminal and run the following command to install firebase cli: npm install -g firebase-tools

  2. Create a .env file and add the details from the firebase config in step 5. It should look like the picture below with the details filled completely:




Installation

  1. A Github account is required as well as the latest version of Git

  2. To install our app you will have to clone the SweatSession repository

    • You can use your terminal or git bash using the git clone command: gh repo clone COS301-SE-2023/SweatSession
    • First go to our repository on Github and copy our repository url: Github/SweatSession
    • Then open the terminal or git bash on the folder you want to save the project and run the git command.

Install Dependencies

  1. Run the following command: yarn install

Deployment/Running

  1. To run the project on Windows:

    • Run the following command: ng serve

  2. To run the project on Linux or Mac:

    • Run the following command: yarn start

  3. To access the app, open the browser of your choice to localhost:4200



Hosting

  1. The SweatSession app has been deployed using Firebase hosting.

  2. Link to deployed app: SweatSession/App


User Manual

Clone this wiki locally