forked from Miruro-no-kuon/Miruro
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
**Implementations and Configurations:**
- **Added `dotenv`**: Implemented environment management using `dotenv`. - **Adjusted Ports**: - *Vite*: Modified server port settings. - *Express*: Altered server port settings. - **Refined Vite Build Configuration**: Enhanced the build configuration settings. - **Cleaned `package.json`**: Removed unused and deprecated dependencies. **Formatting and Styling:** - **Applied `Prettier` Formatting**: Ensured code formatting adheres to Prettier standards. - **Styled 'Close' Button**: Improved the visual design of the close button on `EpisodeCard`. **Code Refactoring and Fixes:** - **Refactored Profile Page**: Overhauled Profile Page (Note: Still not ready for production). - **Fixed Infinite Loop Issue**: Resolved a major issue with infinite loops caused by search parameter conflicts. **Feature Additions:** - **Added Upcoming Season Fetch Function**: Implemented functionality to fetch upcoming seasons. - **Added `useSeason` Hook**: Introduced a new hook (`getSeason`) for retrieving season details. - **Integrated Upcoming Season List on Home**: Displayed upcoming seasons on the home page. **Player Adjustments:** - **Modified Player Load Behavior**: Changed the player's load behavior from on `play` request to `eager` loading.
- Loading branch information
akionii
committed
Apr 14, 2024
1 parent
5de59d5
commit 6a74ca0
Showing
20 changed files
with
532 additions
and
484 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,24 +26,24 @@ MIRURO | |
|
|
||
| ## What is Miruro? | ||
|
|
||
| Welcome to **Miruro** - your ultimate anime destination! 😎 Explore **[miruro.com](https://www.miruro.com)** and dive into the world of anime, powered by the incredible **[Consumet API](https://github.com/consumet)**. | ||
| Welcome to **Miruro** - your ultimate anime destination! 🤯 Explore **[miruro.com](https://www.miruro.com)** and dive into the world of anime, powered by the incredible **[CONSUMET API](https://github.com/consumet)**. | ||
|
|
||
| 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 🪴 | ||
| <!-- ## Features 🪴 --> | ||
|
|
||
| <details> | ||
| <summary>View More</summary> | ||
| <summary>Features [View More]</summary> | ||
|
|
||
| ### General | ||
|
|
||
| - Dub Anime support | ||
| - User-friendly interface | ||
| - Mobile responsive | ||
| - Fast page load | ||
| - White/Dark theme | ||
| - Light/Dark theme | ||
| - Continue watching section | ||
|
|
||
| ### Watch Page | ||
|
|
@@ -66,7 +66,7 @@ Enjoy your favorite shows with English subs or dubs, and here's the kicker - you | |
| <div style="text-align: left;"> | ||
| <img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/home-page.webp" alt="Home Page" style="max-width: 70%;" > | ||
| <details> | ||
| <summary>View More</summary> | ||
| <summary>Screenshots [View More]</summary> | ||
| <br> | ||
| <img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/splash-page.webp" alt="Splash Page" style="max-width: 70%;"> | ||
| <img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/watch-page.webp" alt="Watch Page" style="max-width: 70%;"> | ||
|
|
@@ -90,68 +90,89 @@ cd Miruro | |
|
|
||
| ### Basic Pre-Requisites | ||
|
|
||
| This platform is built on <a href="https://nodejs.org/">`Node.js`</a> and utilizes <a href="https://bun.sh/">`bun`</a> 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. | ||
| 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. | ||
|
|
||
| ### Verify installations | ||
| > Bun is now available on **Windows**, **Linux**, and **macOS**. Below are the installation commands for each operating system. | ||
| ### Install Bun | ||
|
|
||
| - Linux & macOS | ||
|
|
||
| ```bash | ||
| node -v | ||
| bun -v | ||
| curl -fsSL https://bun.sh/install | bash | ||
| ``` | ||
|
|
||
| ### Install Dependencies (npm also works) | ||
| - 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 | ||
| bun install && cd server && bun install | ||
| node -v | ||
| bun -v | ||
| ``` | ||
|
|
||
| #### or | ||
| ### Install Dependencies | ||
|
|
||
| - You can use Bun to install dependencies quickly. If you prefer, `npm` can also be used with equivalent commands. | ||
|
|
||
| ```bash | ||
| bun iu | ||
| bun install | ||
| ``` | ||
|
|
||
| ### Copy the `.env.example` contents to `.env` in the root folder | ||
| ### 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` | ||
|
|
||
| ```bash | ||
| cp .env.example .env | ||
| cp .env.example .env.local | ||
| ``` | ||
|
|
||
| ### 3. Run on development &/or production (npm also works) | ||
|
|
||
| #### Start development version | ||
| - Run on development mode | ||
|
|
||
| ```bash | ||
| bun run dev | ||
| ``` | ||
|
|
||
| #### Start production version | ||
| - Run on production mode | ||
|
|
||
| ```bash | ||
| bun start | ||
| ``` | ||
|
|
||
| ## For Local Development 💻 | ||
|
|
||
| Please be aware that 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 consequences, including potential site takedown measures. | ||
| **⚠️ 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 **your own Miruro** Instance | ||
| [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMiruro-no-kuon%2FMiruro&env=VITE_BACKEND_URL,VITE_SKIP_TIMES,VITE_PROXY_URL,PORT&project-name=miruro&repository-name=miruro) | ||
|
|
||
| [](https://github.com/Miruro-no-kuon/Miruro/assets/77152696/98b95343-a15b-4302-92ee-e4910860887e) | ||
|
|
||
| ## 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](https://www.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](LICENSE) file. Got questions or need special permissions? Feel free to shoot us a message! | ||
| 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](https://www.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](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](https://github.com/Miruro-no-kuon/Miruro-no-Kuon/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. | ||
| Got questions, suggestions, or just wanna say hi? Drop us a line at <[email protected]>. You can also hang out with us on Discord. | ||
|
|
||
| - Visit our website at **[Miruro.com](https://www.miruro.com)** | ||
|
|
||
|
|
@@ -165,7 +186,7 @@ Got questions, suggestions, or just wanna say hi? Drop us a line at miruro@proto | |
|
|
||
| ## Support & Contributions 🤲 | ||
|
|
||
| #### [Star this project](https://github.com/Miruro-no-kuon/Miruro) ⭐️ | ||
| - 🌟 [**THIS PROJECT**](https://github.com/Miruro-no-kuon/Miruro) | ||
|
|
||
| #### Want to Help Out? | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.