From 80bfeb45171d0ba64b40126a72d8e3e217046221 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Thu, 30 Nov 2023 19:40:23 +0100 Subject: [PATCH] Update readme --- .github/logo-dark.svg | 1 + .github/logo-light.svg | 1 + README.md | 117 ++++++++++++++++++++++------------------- 3 files changed, 66 insertions(+), 53 deletions(-) create mode 100644 .github/logo-dark.svg create mode 100644 .github/logo-light.svg diff --git a/.github/logo-dark.svg b/.github/logo-dark.svg new file mode 100644 index 00000000..07dc234c --- /dev/null +++ b/.github/logo-dark.svg @@ -0,0 +1 @@ +MOVIE-WEB \ No newline at end of file diff --git a/.github/logo-light.svg b/.github/logo-light.svg new file mode 100644 index 00000000..51b5a8d2 --- /dev/null +++ b/.github/logo-light.svg @@ -0,0 +1 @@ +MOVIE-WEB \ No newline at end of file diff --git a/README.md b/README.md index fd21a07e..d2c757fe 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,93 @@ -

movie-web

+

+

-GitHub Workflow Status -GitHub license -GitHub forks -GitHub stars -
-Discord Server + +
+ 🔵 discord 🟢 website

+

-movie-web is a web app for watching movies easily. Check it out at **[movie-web.app](https://movie-web.app)**. +# ⚡What is movie-web? + +movie-web is a web app for watching movies easily. Check it out at movie-web.app. This service works by displaying video files from third-party providers inside an intuitive and aesthetic user interface. -Features include: +# 🔥Features -- 🕑 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™️) +- Automatic saving of progress - optionally synced to an account. +- Bookmark shows or movies, keep track of what you want to watch. +- Minimalistic interface that only shows whats required - no algorithm to consume you. -## Goals of movie-web +## 🍄 Philosophy -- 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 +This project is meant to be simple and easy to use. Keep features minimal but polished. +We do not want this project to be yet another bulky streaming site, instead it aims for minimalism. -## Self-hosting +On top of that, hosting should be as cheap and simple as possible. Just a static website with a proxy, with an optional backend if you want cross-device syncing. -A simple guide has been written to assist in hosting your own instance of movie-web. +Content is fetched from third parties and scraping is done fully done on the client. This means that the hoster has no files or media on their server. All files are streamed directly from the third parties. -Check it out here: [https://github.com/movie-web/movie-web/blob/dev/SELFHOSTING.md](https://github.com/movie-web/movie-web/blob/dev/SELFHOSTING.md) +## ⚠️ Limitations -## Running locally for development +- Due to being a static site, there can be no SSR +- To keep it cheap to host, amount of proxied requests need to be kept to a minimum +- Also to keep it cheap, no content must ever be streamed through the proxy. So only streams not protected by CORS headers. -To run this project locally for contributing or testing, run the following commands: -
note: must use pnpm to install packages and run NodeJS 16 (install with `npm i -g pnpm`)
+# 🧬 Running locally for development +To run locally, you must first clone the repository. After that run the following commands in the root of the repository: ```bash -git clone https://github.com/movie-web/movie-web -cd movie-web pnpm install pnpm run dev ``` -To build production files, simply run `pnpm run build`. +To build production files, run: +```bash +pnpm build +``` -You'll need to deploy a cloudflare service worker as well. Check the [selfhosting guide](https://github.com/movie-web/movie-web/blob/dev/SELFHOSTING.md) 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) +> [!TIP] +> You must use pnpm (`npm i -g pnpm`) and run NodeJS 16 -

Contributing - GitHub issues -GitHub pull requests

+# 🧬 Selfhosting -Check out [this project's issues](https://github.com/movie-web/movie-web/issues) for inspiration for contribution. Pull requests are always welcome. +A simple guide has been written to assist in hosting your own instance of movie-web. Check it out below -**All pull requests must be merged into the `dev` branch. it will then be deployed with the next version** +|[Selfhosting guide](https://docs.movie-web.app/self-hosting/self-hosting)| +|---| -## Credits + +## Contributors 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. -
- -
-@binaryoverload for help rewriting the application into React and making the README look ✨ pretty ✨. -
- -
-@lem6ns for helpfully implementing extra scrapers. -
+ + + + + + + + + + + + +
+
+ @JamesHawkinss + 		+
+ @JipFr + 		+
+ @mrjvs + 		+
+ @binaryoverload +
+
+ @lem6ns +