Giter VIP home page Giter VIP logo

arthouseboxoffice-server's Introduction

Art House Box Office Server

API server for the Art House Box Office project.

Installation

Clone the repository and run:

npm install  

Set the following environment variables:

  • MONGO_URI -- should point to a mongoDB connection. Ex: mongodb://localhost/ahbo
  • APP_SECRET -- a string used to generate tokens
  • PORT -- what port you would the app to run on. The default if none is specified is 9000. This can also be specified in the command line as an option to index.js.

Then, run:

npm run start:watch

The default user is Admin and the default password is 'password'. You are encouraged to create a new user, set it as admin, and delete Admin immediately.

Things you can do with the REST API

SIGN UP


SIGN UP

URL: /api/signup
Method: POST Description: Creates a new user and returns a token. The token must be included in all API calls in the header as the VALUE for the KEY 'token'.
Authorized roles: N/A
Inputs:

  • username --the username must be unique. an error will be returned if the username if found in the database.
  • password --The password is encrypted before saved to database.
  • roles (OPTIONAL) --an admin role can only be assigned with the CREATE USER or UPDATE USER end points

Outputs:

  • token

arthouseboxoffice-server's People

Contributors

goodwid avatar yvonnehayes avatar donchatelain avatar billyham avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.