movie-web/README.md
James Hawkins 98ebc9aec8
add me lol
2022-12-27 16:33:30 +00:00

5 KiB

movie-web

GitHub Workflow Status GitHub license GitHub forks GitHub stars
Discord Server

movie-web is a web app for watching movies easily. Check it out at movie.squeezebox.dev.

This service works by displaying video files from third-party providers inside an intuitive and aesthic user interface.

Features include:

  • 🕑 Saving of your progress so you can come back to a video at any time!
  • 🔖 Bookmarks to keep track of videos you would like to watch.
  • 🎞️ Easy switching between seasons and episodes for a TV series; binge away!
  • ✖️ Supports multiple types of content including movies, TV shows and Anime (coming soon™️)

Goals of movie-web

  • No ads
  • No BS: just a search bar and a video player
  • No responsibility on the hoster, no databases or api's hosted by us, just a static site

Self-hosting

A simple guide has been written to assist in hosting your own instance of movie-web.

Check it out here: https://github.com/movie-web/movie-web/blob/dev/SELFHOSTING.md

Running locally for development

To run this project locally for contributing or testing, run the following commands:

note: must use yarn to install packages and run NodeJS 16
git clone https://github.com/JamesHawkinss/movie-web
cd movie-web
yarn install
yarn start

To build production files, simply run yarn build.

You'll need to deploy a cloudflare service worker as well. Check the selfhosting guide on how to run the service worker. Afterwards you can make a .env file and put in the URL. (see example.env for an example)

Contributing - GitHub issues GitHub pull requests

Check out this project's issues for inspiration for contribution. Pull requests are always welcome.

All pull requests must be merged into the dev branch. it will then be deployed with the next version

Credits

This project would not be possible without our amazing contributors and the community.

GitHub contributors

@JamesHawkinss for original concept.
@JipFr for initial work on movie-cli.
@mrjvs for leading the port to React, and for the beautiful design.
@JoshHeng for the Cloudflare CORS Proxy and URL routing.
@binaryoverload for help rewriting the application into React and making the README look pretty .
@lem6ns for helpfully implementing extra scrapers.