Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 3.87 KB

README.md

File metadata and controls

91 lines (67 loc) · 3.87 KB
Raw

findaloo logo

Netlify Status

It doesn't always have to stink.

Findaloo is a progressive web application designed to help you find the nearest toilets around you! See how far away they are, what genders are avaiable, or even see a list of features available. Are you a parent? Find the nearest nursing rooms with hot water dispensers and baby change stations around you.

Just had the most wonderful experience in your lifetime so far? Leave a review! Upset that something broke? File a report to let management know.

With findaloo, dirty, smelly toilets will be a thing of the past. Visit us at https://findaloo.netlify.app today!

Team Members

1. Phillmont Muktar A0184545X

Role: Frontend Developer
Contribution: UI Design, Explore pages

2. Tan Jin Ying A0168492R

Role: Frontend Developer
Contribution: Profile, Report and Review pages

3. Jiang Yuxin A0177868A

Role: Frontend Developer
Contribution: Authentication, List page

4. Agnes Natasya A0184576N

Role: Backend Developer
Contribution: Data scraping, Authentication routes, Toilet Routes, Image upload (profile photo)

5. Daniel Wong A0185050M

Role: Backend Developer
Contribution: Authentication, Toilet routes, User Profile routes, Report & Review routes

Installation guide

In order to run the application, please follow the steps below. The application is divided into two main folders: the frontend and the backend. These can be run on separate servers, or together on the same server.

Before you begin:

  1. git clone https://github.com/cs3216/2020-a3-mobile-cloud-2020-group-3.git to clone the repo
  2. Ensure that node.js >v11. and PostgreSQL > v12. is installed on the system
  3. Ensure that the yarn package manager is installed
  4. yarn add nodemon to install nodemon, which is required to launch the package scripts.

Frontend:

We recommend that you deploy on netlify. However, for local deployment, follow the steps below:

  1. cd frontend to change directory to the frontend folder
  2. yarn install to install the required packages for the application
  3. yarn start to launch the application. The application will be available on localhost:3000.

Backend:

Deployment of the backend happens in multiple stages, listed below.

Database setup

  1. psql to launch an interactive postgres shell
  2. CREATE USER findaloo to create a new user
  3. CREATE DATABASE findaloo to create a corresponding database
  4. \q to quit psql
  5. cd backend/sql to open the sql folder
  6. psql findaloo to open the findaloo database
  7. \i 1_ppp.sql to initialise the database tables
  8. \i n_filename.sql in order of increasing numbers in the current folder to load SQL views
  9. [OPTIONAL] cd ../scripts to open the scripts folder
  10. [OPTIONAL] \i n_filename.sql in order of increasing numbers in the current folder to load sample data

Database authentication setup

  1. cd ../db to enter the db folder
  2. cp settings_blank.js settings.js to create a settings.js file
  3. Open settings.js and fill up the details in line 1 - 5 with the database user information.

Running the server

  1. cd ../ to return to the backend folder
  2. yarn install to install the required packages for the application
  3. yarn start to launch the API server. It will be available on localhost:3000.
  4. yarn startAuth to launch the Auth server. It will be available on localhost:4000.

Screenshots

Map View

Toilet

Review

Profile