mirror of https://github.com/ajayyy/SponsorBlockServer.git synced 2024-09-20 04:54:00 +02:00

Skip YouTube video sponsors (server side portion)

hacktoberfest sponsorblock sponsored-segments youtube

Find a file

Dainius Dauksevicius 7da9de9991 fix nodemon to watch .ts files		2020-11-01 17:29:57 +02:00
.github/workflows	Added Github actions	2020-04-06 16:46:19 -04:00
databases	added warning system	2020-09-16 00:56:10 +02:00
src	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00
test	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00
.editorconfig	migrate to typescript	2020-10-26 19:13:30 +02:00
.gitignore	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00
config.json.example	Merge branch 'master' into 147-add-cache-for-gettopusers	2020-10-14 18:35:15 -04:00
Dockerfile	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00
entrypoint.sh	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00
LICENSE	Create LICENSE	2019-08-19 20:59:10 -04:00
nodemon.json	fix nodemon to watch .ts files	2020-11-01 17:29:57 +02:00
package-lock.json	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00
package.json	fix nodemon to watch .ts files	2020-11-01 17:29:57 +02:00
README.MD	Merge pull request #67 from ajayyy/testing	2020-04-19 18:59:00 -04:00
test.json	Merge branch 'master' into feature/getuserinfo	2020-10-14 18:34:27 -04:00
tsconfig.json	fix docker build, add proper mocks to tests, remove YouTubeAPI dependency on youtube test mock, move index.ts and test.ts to /src ant /test folders	2020-10-26 19:13:30 +02:00

README.MD

SponsorBlock Server

SponsorBlock is an extension that will skip over sponsored segments of YouTube videos. SponsorBlock is a crowdsourced browser extension that let's anyone submit the start and end time's of sponsored segments of YouTube videos. Once one person submits this information, everyone else with this extension will skip right over the sponsored segment.

This is the server backend for it

Server

This is a simple Sqlite database that will hold all the timing data.

To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database.db. You can download a backup or get archive.org to take a backup if you do desire. The database is under this license unless you get explicit permission from me.

Hopefully this project can be combined with projects like this and use this data to create a neural network to predict when sponsored segments happen. That project is sadly abandoned now, so I have decided to attempt to revive this idea.

Client

The client web browser extension is available here: https://github.com/ajayyy/SponsorBlock

Build Yourself

This is a node.js server, so clone this repo and run npm install to install all dependencies.

Make sure to put the database files in the ./databases folder if you want to use a pre-existing database. Otherwise, a fresh database will be created.

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