Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miruro-no-kuon/miruro
not a bug, but a feature
https://github.com/miruro-no-kuon/miruro
anilist anilist-tracker anime anime-api anime-downloader anime-scraper anime-streaming anime-website bun gogoanime graphql miruro miruro-no-kuon streaming-video styled-components typescript vercel-serverless vite
Last synced: 6 days ago
JSON representation
not a bug, but a feature
- Host: GitHub
- URL: https://github.com/miruro-no-kuon/miruro
- Owner: Miruro-no-kuon
- License: other
- Created: 2022-11-16T21:26:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-20T16:57:19.000Z (17 days ago)
- Last Synced: 2025-01-24T19:06:57.818Z (13 days ago)
- Language: TypeScript
- Homepage:
- Size: 12.1 MB
- Stars: 740
- Watchers: 11
- Forks: 200
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
MIRURO
## What is Miruro?
Welcome to **Miruro**, your premier destination for all things anime! Explore a comprehensive collection of high-definition anime with a seamless and user-friendly interface powered by **[Consumet](https://github.com/consumet)**.
Built using **React** and **Vite**, Miruro offers a cutting-edge, minimalist design that ensures both fast loading times and smooth navigation. Whether you're looking for the latest anime series or classic favorites, Miruro has you covered with an ad-free streaming experience that supports both English subtitles and dubbed versions. Additionally, you can download individual episodes without the hassle of creating an account, making your viewing experience as convenient as possible.
Features [View More]
### General
- Sub/Dub Anime support
- User-friendly & Mobile responsive
- Anilist Sync
- Light/Dark theme
- Continue Watching Section
### Watch Page
- **Player**
- Autoplay next episode
- Skip op/ed button
## Installation and Local Development
### 1. Clone this repository using
```bash
git clone https://github.com/Miruro-no-kuon/Miruro.git
```
```bash
cd Miruro
```
### 2. Installation
### Basic Pre-Requisites
> [!TIP]
> This platform is built on [Node.js](https://nodejs.org/) and utilizes [Bun](https://bun.sh/) 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
```bash
curl -fsSL https://bun.sh/install | bash
```
- Windows
```powershell
powershell -c "irm bun.sh/install.ps1 | iex"
```
### Verify installations
- Check that both Node.js and Bun are correctly installed by running.
```bash
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.
```bash
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` or
`.env.production.local`
```bash
cp .env.example .env.local
```
### 3. Run on development &/or production (npm also works)
- Run on development mode
```bash
bun run dev
```
- Run on production mode
```bash
bun start
```
## Self-Hosting Notice
> [!CAUTION]
> 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.
## License
This project is governed by a Custom BY-NC License. What does this entail? Simply put, you are permitted to utilize, distribute, and modify the code for non-commercial purposes. However, it is imperative that due credit is accorded to our platform. Any commercial utilization of this code is strictly prohibited. For comprehensive details, please refer to the [LICENSE](LICENSE) file. Should you have inquiries or require special permissions, do not hesitate to contact us.
## Star History
[](https://starchart.cc/Miruro-no-kuon/Miruro)