Skip to content
This repository has been archived by the owner on Jul 25, 2020. It is now read-only.

Latest commit

 

History

History
58 lines (49 loc) · 1.58 KB

README.md

File metadata and controls

58 lines (49 loc) · 1.58 KB
Raw

Overview

Dancing game app which scores your dance moves and also allows you to save your dance moves. This project was created as a part of senior project during our time at Code Chrysalis. We created this project in 3 weeks. This repository has code only for the backend of this project. Frontend repo is here

Technologies used:

  • ExpressJS server
  • MongoDB
  • Mongoose

Pre-requisites before getting started

In order to get started, you need following accounts:

  • Mongo DB database locally on your computer or on a cloud service like Atlas
  • Auth0 account
  • .env file in root directory

Environment variables

DB_USER_NAME=<MongoDB username>
DB_PASSWORD=<MongoDB password>
COLLECTION_NAME_SONGS=<Database name in MongoDB>
DB_URL=<URL to connect to your MongoDB>
MGMT_API_ACCESS_TOKEN=<Auth0 API Access Token>
AUTH_DOMAIN=<Domain of your Auth account>
PORT=<Port which server should listen to>

RESTful Enpoints

  • GET /api/songs
  • POST /api/songs
  • GET /api/songs/:titleOrCode
  • GET /api/moves/:songcodeOrMoveid
  • POST /api/moves
  • POST /api/scores
  • GET /api/scores
  • GET /api/scores/:songId/:moveId
  • GET /api/scores/:userId
  • POST /api/users
  • GET /api/users/:userID

How to get started

To install dependencies

yarn

Start the server on PORT specified in environment variables Or your system port

yarn start

Once you start server, following models should be created in MongoDB in your database

  • songs
  • moves
  • scores
  • users

Acknowledgement

Code Chrysalis