Skip to content
StarCraft II Profile Twitch extension - backend service (EBS)
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.env.sample
.eslintrc.js
.gitignore
.travis.yml
LICENSE
README.md
package-lock.json
package.json

README.md

sc2profile-twitch-extension-api

Travis Build Status Greenkeeper badge Maintainability Test Coverage

This is an official repository of the backend service (EBS) for StarCraft II Profile Twitch Extension.

For current status see the kanban board of the project.

Setup

To run a server you need Node.js (preferably LTS version), MongoDB and Redis installed. MongoDB and Redis must be running before starting the API server.

Launching MongoDB as a service in Ubuntu and tailing the log file:

$ sudo service mongod start
$ tail -f /var/log/mongodb/mongod.log

Use cp .env.sample .env to create an environment variables file based on the provided template. Fill it with the following details:

When running the API via HTTPS you need a SSL key / certificate pair. For localhost you can create a self-signed cert. Rename the key and the cert respectively to server.key and server.crt. Copy them to ssl/ directory of the project.

When configured correctly, you can launch the project with npm run dev.

You can now proceed to set up the extension frontend.

Contact

See the project homepage for contact information.

License

Code is available under MIT license. See LICENSE for more information.

You can’t perform that action at this time.