Skip to content

Latest commit

 

History

History
129 lines (98 loc) · 5.1 KB

README.md

File metadata and controls

129 lines (98 loc) · 5.1 KB
Raw
logo

Munchyroll

An ad-free anime streaming web app aimed at minimality and responsive design.

Live demo at anime.j21.dev


license fork stars

Images

main main

More Screenshots

Anime Home Page (Dark Mode)

Anime Info Page (Dark Mode)

Anime Watch Page (Dark Mode)

Manga Home Page (Light Mode)

Manga Info Page (Light Mode)

Manga Read Page (Light Mode)

Features

  • No Ads - No ads, no popups, no redirects, no bullshit
  • PWA Support - Munchyroll has PWA (Progressive Web App) support, which means that you can add it to your home screren as an app
  • Time Responsive Background - The background color changes based on what your local time is. It starts off at a rich yellow in the morning, blue in the afternoon, to a faded red in the evening, and space black in the night
  • Mobile Responsiveness - The website will scale down to look good on mobile just as it does on desktop

Bug Reports

If you encounter any strange bugs on the website, please let me know by going to issues and create a bug report

Local Development

Caution

If you want to self host this app, please note that it's only allowed for personal use Commercial use is not recommended

1. Environment Variable file setup

  1. Copy all the contents of .env.example into a new file called .env

2. Backend Repository (Consumet API)

Tip

If you already have a backend URL from somewhere, you can skip this step and go to step 3

  1. Clone the backend repository and install the dependencies:
$ git clone https://github.com/consumet/api.consumet.org.git
$ cd api.consumet.org
$ npm install # Or yarn install
  1. Start the backend server
$ npm start
  1. Put your backend URL into the NEXT_PUBLIC_CONSUMET_URL variable in the .env file

3. Frontend Repository (Munchyroll)

  1. Clone this repository and install the dependencies:
$ git clone https://github.com/Jeydin21/Munchyroll.git
$ cd Munchyroll
$ npm install # Or yarn install
  1. Start the development server
$ npm run dev
  1. Open the project in your browser:
http://localhost:3000

Extra Steps (OPTIONAL)

  • If you want, you can host a CORS proxy. The recommended CORS proxy for this project is this one: Rob--W/cors-anywhere. You can host this on vercel and save the link into the NEXT_PUBLIC_CORS_REQUEST_LINK variable in the .env file
  • You can turn on your own website tracking with Google Analytics, go to https://analytics.google.com/ and follow their setup instructions. Save the Tracking ID into the NEXT_PUBLIC_GA_TRACKING_ID variable in the .env file
  • You can turn on your own website tracking with Umami, go to https://umami.is/ and follow their setup instructions. Save the Website ID into the NEXT_PUBLIC_UMAMI_WEBSITE_ID variable in the .env file
  • You can turn on live customer communication with Tawk.to, go to https://tawk.to and follow their setup instructions. Save the Property ID and Widget ID into the NEXT_PUBLIC_TAWKTO_PROPERTY_ID and NEXT_PUBLIC_TAWKTO_WIDGET_ID variables, respectively

Credits

  • Consumet API for all anime details and sources
  • Anilist was used to provide extensive episode details and statistics

License

This project is licensed under the GNU General Public License v3.0 - see the License file for more details

Contact

Thanks for checking my project out

If you have any questions or feedback, go to my website and pick your preferred method of contact. You can also join the community Discord server I made down below:

Discord Banner