shiftWerk

shiftWerk is a community shift planning application that connects shift workers with shift work

Team

• Product Owner: daft-punk thesis
• Scrum Master: Jay Kindell
• Development Team Members: Alexa Welch, Taniecia Duplantis, David Lum, Frank D'Amico

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

• npm start: runs nodemon for development
• use a process manager like PM2 or Forever for production

Requirements

• Node 10.15.0
• PostgreSQL 9.6

Testing

• npm test
• to run only individual suites, npx jest test/<insert file here>

Development

• db/index.js - the database configuration
• server/server.js - the server

Installing

From within the root directory:

npm install

You will need a .env file in the root directory with the following variables:

TOMTOM_API_KEY
GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
DBHOST
DBUSERNAME
DBPASSWORD
DBNAME
TWILIO_SID
TWILIO_AUTH_TOKEN
TWILIO_PHONE
TWILIO_MESSAGING_SERVICE_SID
TWILIO_NOTIFY_SERVICE_SID
SUPER_SECRET_KEY

You will need to register your project with Google API Console for your Client ID and Secret. You will also need an account with both Tomtom (Search API) and Twilio (Messaging and Notify services).

This API server is meant to work with the client, located here.

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.