Skip to content

Latest commit

 

History

History
148 lines (109 loc) · 4.86 KB

README.md

File metadata and controls

148 lines (109 loc) · 4.86 KB
Raw

TraceTheGather

TraceTheGather is a web application for companies to keep track of employee gatherings and meetings and carry out contact tracing in midst of the COVID-19 pandemic.
Explore the docs »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Acknowledgments

About The Project

![img.png](img/webpage sample.png) To curb the spread of COVID-19 in the workplace, companies have to monitor the health of employees and keep track of close contacts of COVID-19 positive cases within the company. Given that this is a rather new process for companies, most of these processes are done manually. In order to improve productivity in the workplace, we have designed this web application to help companies with the following:

  • Keep track of departments within the company
  • Keep track of employees within each department
  • Remind employees to declare their temperature daily
  • Provide alerts when an employee is having a fever
  • Keep track of employees that are in contact during meetings
  • Identify employees who have been in close contact with COVID-19 positive cases during meetings

Built With

Getting started

Prerequisites

  • npm

Run npm install to get required packages. Run npm start and point localhost:3000 to view development server.

Installation

You will need to create an .env file to hide database credentials - This can be a new database, or if you still have the 2102 database you can just use that one. In the .env file:

  • DB_USER=YOUR_USER // should be postgres
  • DB_HOST=127.0.0.1 // this represents localhost, we will migrate to an online db later
  • DATABASE=YOUR_OWN_DB
  • DB_PASSWORD=YOUR_OWN_PASSWORD
  • DB_PORT=5432 //default I believe is 5432

Using Postman (For BE testing of API calls)

You can download Postman here. A sample query is shown below: Sample Postman Query

This occurs cause of this line, and is just an example:

app.post('/user', (req, res) => {
    pool.query('SELECT * FROM departments', (error, results) => {
        if (error) {
          throw error
        }
        res.status(200).json(results.rows)
    })
})

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • [] Feature 1
  • [] Feature 2
  • [] Feature 3
    • [] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Local PSQL DB instructions

Step 1: Create a new database

Log into PostgreSQL (e.g., with psql) and create a new database, e.g.

CREATE DATABASE cs2102_project; -- Feel free to pick your own name

Step 2: Import dump into the newly create database, e.g.:

psql -d cs2102_project -f schema.sql -U postgres -- you might need to add the full path where schema.sql is located psql -d cs2102_project -f proc.sql -U postgres psql -d cs2102_project -f data.sql -U postgres

Acknowledgments

(back to top)