the-oem / happy-hour-power

Turing M4 FEE Capstone Project

Happy Hour Power

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Current Build Status

Prerequisites & Installation

This application is broken up into two distinct pieces, the server and the client. In order to get this running locally, you need to install dependencies for both the client and the server.

• Clone this repo

git clone [e-mail]:the-oem/happy-hour-power.git

• Server Dependencies (From the root directory of the project)

npm install

• Client Dependencies (From the root directory of the project)

cd react-ui
npm install

Running the Application

Running the front end application:

From the root of the project...

cd react-ui
npm start

Running the server back-end application:

From the root of the project...

npm start

Running the tests

There are two distinct test suites for this application, one for the front-end and one for the back-end.

Running the front end tests:

From the root of the project...

cd react-ui
npm test

Running the server back-end tests:

From the root of the project...

npm test

Deployment

This application is currently configured with [CircleCI], and automated Heroku deployments from the master branch. The production URL of the application can be found at https://happyhourpower.herokuapp.com/.

Built With

Front-End Application

Created from a base clone of this repo.

• React - A JavaScript library for building user interfaces
• Redux - a predictable state container for JavaScript apps

Back-End Application

• NodeJS - JavaScript runtime
• ExpressJS - a minimal and flexible Node.js web application used to build the server endpoints
• KNEX - a "batteries included" SQL query builder for Postgres

Contributing

TODO: Add a CONTRIBUTING.md file for future contributors.

Versioning

The API is currently version 1. Future versioning strategies/tools will be documented here.

API Usage

Explanation coming

Success 200/201 Responses:

When data is returned from a successful API request, the data will be formatted in a

{
  data: [<returned data>]
}

Failure 404 Responses:

{
  data: {
    message: <error message (string format)>,
  }
}

Failure 500 Responses:

{
  error: <error object returned from server>,
}

---

Endpoints

Authentication

• POST /api/v1/auth +

Location Resources

• GET /api/v1/locations +
• GET /api/v1/locations/:id +
• POST /api/v1/locations +
• DELETE /v1/locations/:id +

Happy Hour Resources

• GET /v1/locations/:id/happyhours +
• POST /v1/happyhours +
• PUT /v1/happyhours/:id +
• DELETE /v1/happyhours/:id +

LocationType Resources

• GET /v1/locationtypes +
• POST /v1/locationtypes +
• PUT /v1/locationtypes/:id +
• DELETE /v1/locationtypes/:id +

Authors

• Jason Collins - GitHub
• Cole Worsley - GitHub
• Justyna Field - GitHub
• Daniel Bucket - GitHub

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License

Acknowledgments

• Hat tip to anyone who's code was used
• Inspiration
• etc