Shiftly

Automated shift scheduling for small businesses.

Team

• Toby Hoshman
• Vanessa Yip
• Sofie Graham
• Caleb Choi

Table of Contents

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

Usage

Dependencies

To open the app in a dev environment, first install dependencies by running this command in your terminal:

npm install

Database

Then install postgres db:

brew install postgres

If you are prompted, run this to start pg: brew services start postgresql Run pg in your command line:

psql postgres

Check out https://gist.github.com/apolloclark/ea5466d5929e63043dcf for commands. Manually create a database on your local machine using the terminal:

CREATE DATABASE <your database name> WITH OWNER <your owner name>

The default password is "null"

Create local env variables

Creat a .env file in the root folder with the following variables:

• DB_HOST=localhost
• DB_USER={your username for postgres}
• DB_NAME=shiftly
• PORT=9000

Run locally

Once your db is set up, run the app by running each of these command in a seperate terminal window:

npm run react-dev
npm run server-dev
npm run db:setup (one time to seed the database with example data)

Requirements

• Node 6.4.x
• Redis 2.6.x
• Postgresql 9.1.x
• etc
• etc

Development

Installing Dependencies

From within the root directory:

npm install -g bower
npm install

bower install (Do we use bower?!)

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.