From 0f251382e4cdb16a9f814fd36fb7897ca80a3c64 Mon Sep 17 00:00:00 2001 From: Cooper Ransom Date: Wed, 13 Mar 2024 12:26:37 -0400 Subject: [PATCH] Redo readme (pt 1) --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 47 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index be666c78..d21a7e24 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,19 @@ Sudo-Flix is a mirror of [Movie-Web](https://github.com/movie-web/movie-web) wit **I *do not* endorse piracy of any kind I simply enjoy programming and large user counts.** + ## Links And Resources -| Service | Link | Source Code | -|----------------|----------------------------------------------------|------------------------------------------------------| -| Movie-Web Docs | [movie-web-docs](https://movie-web.github.io/) | [Source Code](https://github.com/movie-web/docs) | -| Proxy #1 | [sudo-proxy](https://sudo-proxy.netlify.app) | [Source Code](https://gitlab.com/itzCozi/sudo-proxy) | -| Proxy #2 | [mweb-proxy](https://mweb-proxy.up.railway.app) | [Source Code](https://gitlab.com/itzCozi/sudo-proxy) | -| Proxy #3 | [sudo-proxy2](sudo-proxy.up.railway.app) -| Backend | [sudo-flix-backend](https://sudo-flix-backend.lol) | [Source Code](https://github.com/movie-web/backend) | +| Service | Link | Source Code | +|----------------|----------------------------------------------------|----------------------------------------------------------| +| Movie-Web Docs | [movie-web-docs](https://movie-web.github.io/docs) | [Source Code](https://github.com/movie-web/docs) | +| Extension | [movie-web plugin](https://shorturl.at/iqzES) | [Source Code](https://github.com/movie-web/extension) | +| Proxy | [sudo-proxy](https://sudo-proxy1.sudo-flix.lol) | [Source Code](https://gitlab.com/sudo-flix/simple-proxy) | +| Backend | [sudo-backend](https://backend.sudo-flix.lol) | [Source Code](https://github.com/movie-web/backend) | +| Frontend | [sudo-flix](https://sudo-flix.lol) | [Source Code](https://github.com/sudo-flix/sudo-source) | + **I provide these if you are not able to host yourself, though I do encourage hosting the frontend.** + ## Referrers - [Priacy Subreddit Megathread](https://www.reddit.com/r/Piracy/s/iymSloEpXn) - [Movie-Web Docs](https://movie-web.github.io/docs/instances) @@ -20,6 +23,7 @@ Sudo-Flix is a mirror of [Movie-Web](https://github.com/movie-web/movie-web) wit - Search Engines: DuckDuckGo, Bing, Google - Rentry.co? (This ones a mystery) + ## Running Locally Type the following commands into your terminal / command line to run Sudo-Flix locally ```bash @@ -29,7 +33,42 @@ git pull pnpm install pnpm run dev ``` +Then you can visit the local instance [here](http://localhost:5173) or, at local host on port 5173. + + +## Updating Instances + +### sudo-flix +To update a sudo-flix instance you can type the below commands into a terminal at the root of your project. +```bash +git remote add upstream https://github.com/sudo-flix/sudo-source.git +git fetch sudo-flix # Grab the contents of the new remote source +git checkout # Most likely this would be `origin/main` +git merge upstream/main +# * Fix any conflicts present during merge * +git add . # Add all changes made during merge and conflict fixing +git commit -m "Update sudo-flix instance (merge upstream/main)" +git push # Push to YOUR repository +``` + +### movie-web +To update a movie-web instance you can type the below commands into a terminal at the root of your project. +movie-web has two branches `master` and `dev` sudo-flix always merges the dev branch to get the most recent updates, master is just a stable branch. + +**Note:** To change the target branch for your merge simply replace `master` with `dev` or any other existing branch on the movie-web [repository](https://github.com/movie-web/movie-web). + +```bash +git remote add movie-web https://github.com/movie-web/movie-web.git +git fetch movie-web # Grab the contents of the new remote source +git checkout # Most likely this would be `origin/main` +git merge movie-web/master +# * Fix any conflicts present during merge * +git add . # Add all changes made during merge and conflict fixing +git commit -m "Update movie-web instance (merge movie-web/master)" +git push # Push to YOUR repository +``` + ## Contact Me **Discord:** *.baddeveloper* -**Email:** *sudo-flix@proton.me* \ No newline at end of file +**Email:** *[sudo-flix@proton.me](mailto:sudo-flix@proton.me)*