Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.1 KB

README.md

File metadata and controls

24 lines (13 loc) · 1.1 KB
Raw

ESA Predictions

This is a prototype for an API that will be used to store and show audience predictions for runs.

screenshot of predictions UI

Getting started

You can read some documentation about the project details in the docs folder.

Development

You need a recent version of Node (with NPM) installed in order to run this project.

  1. Run npm install in the root of the repo
  2. Run npm run dev in the root of the repo to start the development server (you can run this as npm run dev:debug to be able to attach a debugger in your editor).

Running in production

You can build the project for production using the command npm run build and later execute npm run start to start the production server. (Or better yet use PM2 to run it).

Contributing

To contribute to this project you can submit pull requests or create issues on this repo. If you want to get more information or help you can join the ESA Marathon Discord channel. A link to this and other social media can be found on the website https://esamarathon.com/