Skip to content

AlessandroFC15/fuck-youtube-server

Repository files navigation

Fuck Youtube Server

CircleCI Heroku codecov

  • This project offers an API that is used by the browser extension called Fuck Youtube. The main goal of this project is to provide an alternative video source for YouTube videos that might be blocked on the user's country.

How to run the project locally

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/AlessandroFC15/fuck-youtube-server

# Go into the repository
$ cd fuck-youtube-server

# Install dependencies
$ npm install

# Run the app
$ npm run dev

How to Contribute

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Clone repo and create a new branch:
git checkout https://github.com/AlessandroFC15/fuck-youtube-server -b name_for_new_branch
  1. Make the necessary changes and test
  2. Submit a Pull Request with a comprehensive description of changes

Running the tests

npm run test

  • Code style used is StandardJS - JavaScript style guide, linter, and formatter

npm run lint

Deployment

  • master -> automatically deploys to Heroku

Any other branch is only built for CI.

License

Distributed under the MIT License. See LICENSE for more information.

About

📹 API that finds a mirror to YouTube videos that are geo-blocked.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published