Skip to content

Latest commit

 

History

History
50 lines (26 loc) · 1.58 KB

README.md

File metadata and controls

50 lines (26 loc) · 1.58 KB
Raw

polls

A React web app for creating, finding, and sharing simple polls.

  • An Express API that allows users to authenticate with Google OAuth and manage polls that can be viewed and voted on by other authenticated users.
  • A React web client for interacting with the API in a browser.

Getting Started

Prerequisites

If you would like to run a local instance of this app in developer mode, the easiest method is using npm, the package manager included with Node.js.

  1. Install Node.js

  2. Install the required JavaScript dependencies using npm

npm run init

Running the API server

To quickly start up an instance of the microservice:

npm run server

Running the API server tests

To run the included tests:

npm test

Running the Client

To quickly start up an instance of the microservice:

npm run client

Running the Client tests

To run the included tests:

cd client && npm test

License

polls is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this code. If not, see http://www.gnu.org/licenses/.