SRLBets is a web app that allows twitch users to bet on the winner of races hosted by SpeedRunsLive. SRLBets extends the SpeedRunsLive API to allow for tracking extra race statistics and further integration with your twitch profile.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To get the application running locally on your machine, install dependencies with npm from both the server and client package.json
Install npm dependencies for the server
npm install
Install the dependencies for the the front-end
cd client && npm install
This app relys on environment variables not contained in this repository to link your app to the twitch API and establish a connection to a mongodb database. For further information on aquiring your own twitch client information, see the Twitch Developer Homepage to set up a new application. For further information on how to set up your own test database with mLab, follow the mLab Quick Start Guide.
To start the app in your local environment
npm run start-dev
The defualt npm start command is configured for use in a heroku deployment and will only start up the server
Tests are built using Mocha/Chai, run them with npm using
npm test
- Node - Web server
- Express - Back-end web framework
- React - Front-end framework
- MongoDB - Database
- mLab - Database hosting
- Twitch API - Twitch user integration/authorization
This project is licensed under the MIT License