Giter Club home page Giter Club logo

miruro's Introduction

MIRURO

Logo

What is Miruro?

Welcome to Miruro - your ultimate anime destination! ๐Ÿคฏ Explore miruro.com and dive into the world of anime, powered by the incredible CONSUMET API.

Crafted with using React and Vite, our site rocks a slick and modern interface. Experience lightning-fast performance and smooth navigation as you explore a vast collection of HD anime titles.

Enjoy your favorite shows with English subs or dubs, and here's the kicker - you can download individual episodes hassle-free, no sign-up required!

Features [View More]

General

  • Dub Anime support
  • User-friendly interface
  • Mobile responsive
  • Fast page load
  • Light/Dark theme
  • Continue watching section

Watch Page

  • Player
    • Autoplay next episode
    • Skip op/ed button
    • Theater mode

Coming Soon

  • Profile page to see your watch list
  • Comment section
  • Anilist/MAL login integration

Images

Home Page
Screenshots [View More]
Splash Page Watch Page Footer

Installation ๐Ÿ› ๏ธ

1. Clone this repository using

git clone https://github.com/Miruro-no-kuon/Miruro.git
cd Miruro

2. Installation

Basic Pre-Requisites

This platform is built on Node.js and utilizes Bun to ensure the quickest response times achievable. While npm can also be used, the commands for npm would mirror those of Bun, simply substituting the specific commands accordingly.

Bun is now available on Windows, Linux, and macOS. Below are the installation commands for each operating system.

Install Bun

  • Linux & macOS
curl -fsSL https://bun.sh/install | bash
  • Windows
powershell -c "irm bun.sh/install.ps1 | iex"

Verify installations

  • Check that both Node.js and Bun are correctly installed by running.
node -v
bun -v

Install Dependencies

  • You can use Bun to install dependencies quickly. If you prefer, npm can also be used with equivalent commands.
bun install

Copy .env.example into .env.local in the root folder

  • .env.local & .env are both viable options, you can also set .env.test.local .env.development.local .env.production.local
cp .env.example .env.local

3. Run on development &/or production (npm also works)

  • Run on development mode
bun run dev
  • Run on production mode
bun start

For Local Development ๐Ÿ’ป

โš ๏ธ RESTRICTED USE

Please be aware: Self-hosting this application is strictly limited to personal use only. Commercial utilization is prohibited, and the inclusion of advertisements on your self-hosted website may lead to serious consequences, including potential site takedown measures. Ensure compliance to avoid any legal or operational issues.

Deploy your own Miruro Instance

Deploy with Vercel

Vercel_Deploy_Guide.mp4

License ๐Ÿ“

Hey there! Just so you know, this project follows a Custom BY-NC License. What does that mean? Well, you're welcome to use, share, and tinker with the code as long as it's for non-commercial purposes. Oh, and don't forget to give credit to our platform, miruro.com. If you're thinking of using it for commercial stuff, sorry, that's a no-go. For all the details, check out the LICENSE file. Got questions or need special permissions? Feel free to shoot us a message!

Found a Bug? ๐Ÿž

Uh-oh, looks like you stumbled upon a bug? No worries, we're here to squash it! Just head over to our issues section on GitHub and let us know what's up.

Get in Touch! ๐Ÿ“ง

Got questions, suggestions, or just wanna say hi? Drop us a line at [email protected]. You can also hang out with us on Discord.

Discord Banner 2

Support & Contributions ๐Ÿคฒ

Want to Help Out?

Feel free to contribute to this project! Whether you're an experienced developer or have been in the field for a while, your help is valuable.

Star History ๐Ÿ“ˆ

Stargazers over time

miruro's People

Contributors

akionii avatar trying559 avatar dependabot[bot] avatar renoschubert avatar renovate[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.