Welcome to our COMP 3613 Software Engineering Project! This project aims to provide the frontend of an application that is geared towards the logging of potholes located across the roadways of Trinidad and Tobago. This project will be implemented to interface with the corresponding SpotDPothole Backend. Please note that this project reflects the various prototype stages that will be refined over the course of many sprints. Implemented features of the first prototype can be found below.
For the first prototype of the application, the following features have been implemented during development:
- Registration and login to application
- Reporting of a pothole via standard interface.
- Reporting of a pothole via driver interface.
- Viewing of reports of other users.
- Viewing of reported potholes.
- Accessing analytical information for potholes.
- Voting on a report of a pothole.
- Bootstrap 5 - Bootstrap 5 used for styling and components
- Picong Party Electoral District API - Picong Party API for electoral district data.
- Leaflet - Leaflet used the general map.
- Node.js/NPM - Used in the installation of dependencies.
- Firebase - Firebase used for serving application website.
- Firebase Storage - Firebase storage used for storing reported images.
- Puppeteer - Chromium based automation for testing.
- Mocha - Mocha used as a testing framework.
- Chai - Chai used in testing as an assertion library.
- Jest - Javascript based testing framework.
After successful installation of Node.js from the website, the execution of the following command can be used to install the frontend dependencies for development:
$ npm install
After installing the dependencies, login to the firebase CLI using the following command:
$ firebase login
Upon successful login, the firebase project can be initialized using:
$ firebase init
Create a new project or choose an existing one. Be sure to select firebase hosting when prompted to select a service. Configure the rest of prompts as needed or press enter for the rest. This should complete the firebase setup.
In the development environment, the frontend webpage can be served using:
$ firebase serve
In the production environment, the frontend webpage can be deployed using:
$ firebase deploy
In the development environment, testing can be carried out using the following command. For Unit Tests
$ npm run utest
For Integration Tests
$ npm run itest
For End to End Tests
$ npm run e2etest
Tests can also be modified by editing the test files located in the /test folder.