Score Board Server is a server for the Score Board project (https://lud2k.github.io/score-board/public/index.html). You can use Score Board without a backend but having a backend makes adding scores from the UI a lot easier.
Score Board Server can simply be launched by running the score-board-server command.
Here is an setup example:
# install score-board-server globallynpm install -g score-board-server# write a configuration file (see "configuration" section below)vim config.json# start the serverscore-board-server
You may want to not install the project globally, in which case you could instead do the following:
# initialize a npm project and install in this projectnpm initnpm install --save score-board-server# write a configuration file (see "configuration" section below)vim config.json# write a script (optionally you can pass the config to startServer())echo "require('score-board-server').startServer()" > index.js# run your scriptnode index.js
In case it crashes, you can also hook this up to Forever.
The file config.json should be created and should contain the following values.
The best way to work on this project is to run
npm run dev. This will start
a web server on the port 3030. You can then open
your favorite browser. Any change you make to the code will trigger a restart
of the server.
You may also run the following commands:
npm run buildto build the project
npm run lintto lint the code
This project is licensed under the terms of the MIT license.