external/SponsorBlockServer
1
0
Fork 0
mirror of https://github.com/ajayyy/SponsorBlockServer.git synced 2024-11-10 01:02:30 +01:00
Code Issues Projects Releases Packages Wiki Activity

updated the readme

Browse source
This commit is contained in:
Joe-Dowd 2020-04-04 00:19:28 +01:00
parent 2f9f4c2bc0
commit 870b80998e
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.MD
View file

@ -20,12 +20,17 @@ The client web browser extension is available here: https://github.com/ajayyy/Sp
This is a node.js server, so clone this repo and run `npm install` to install all dependencies.
Make sure to create the databases in the `databases` folder out of the database schemas.
If you don't want to use a fresh database, make sure to put the database files in the `./databases` folder if you want to use an pre-existing database.
Rename `config.json.example` to `config.json` and fill the parameters inside. Make sure to remove the comments as comments are not supported in JSON.
Ensure all the tests pass with `npm test`
Run the server with `npm start`.
# Developing
If you want to make changes, run `npm run dev` to automatically reload the server and run tests whenever a file is saved.
# API Docs
Available [here](https://github.com/ajayyy/SponsorBlock/wiki/API-Docs)