Skip to content
This repository has been archived by the owner on Dec 11, 2023. It is now read-only.

Technical Installation Manual

TumiPare edited this page Aug 1, 2023 · 3 revisions

Introduction

Where is the power is a web app accessible on mobile and desktop that gives the user a map overlay of areas where loadshedding is currently happening, to help assist users navigate their routes through these dark times. To get a local instance of the system running on your personal computer, you need to start the backend and the frontend independantly. Database is classified currently.

Prerequisites

Before installing the system, ensure you have the following prerequisites installed:

  1. Node - Version 16

    Installing Node

  2. Ionic - Version 7.1.1

    npm install -g @ionic/cli more info

Installation

Follow the steps below to install and run the system:

  1. Clone the master branch of the repository from GitHub:

    git clone https://github.com/COS301-SE-2023/Where-is-the-power
  2. Move to the api directory

    cd Where-is-the-power/api
  3. Start the backend

    cargo run
  4. Move to the app direcotry

    cd Where-is-the-power/app
  5. Install all other dependencies

    npm install
  6. Start the frontend

    ionic serve -o
  7. For more info on how to use the system consult the User Manual.

Clone this wiki locally