Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 2.6 KB

README.md

File metadata and controls

110 lines (79 loc) · 2.6 KB

🌸 Kushiro - Your Random Anime Selector

✨ Overview

Kushiro is a simple yet delightful tool designed to fetch and display random anime from your "Plan to Watch" list on MyAnimeList (MAL). If you're unsure what to watch next, let Kushiro surprise you with a random pick!

🌟 Features

  • 🎲 Fetches random anime from your "Plan to Watch" list.
  • 💻 User-friendly web interface.
  • 🚀 Quick setup and seamless integration with MyAnimeList.

🔧 Prerequisites

Before starting, ensure you have the following installed on your system:

🛠 Installation

Follow these steps to set up Kushiro on your local machine:

1️⃣ Clone the Repository:

git clone https://github.com/desujoy/kushiro
cd kushiro

2️⃣ Set Up the Environment:

  • Retrieve your MyAnimeList Client ID by creating an application on MyAnimeList API Configuration.
  • Copy the Client ID and paste it into the sample.env file.
  • Rename sample.env to .env: 
    mv sample.env .env

3️⃣ Install Dependencies:

npm install

4️⃣ Start the Application:

node index.js

5️⃣ Access the Application:

Open the application in your browser at:
http://localhost:3000/

📸 Screenshots

🏠 Desktop

🎬 Mobile

🤝 Contributing

We ❤️ contributions! Here’s how you can contribute:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature-name
  3. Make your changes and commit them: 
    git commit -m "Add your descriptive message here"
  4. Push your branch: 
    git push origin feature-name
  5. Create a pull request on GitHub.

📜 License

This project is licensed under the MIT License.

🛡 Support

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository.

📖 Additional Notes

  • Ensure your MyAnimeList account has the "Plan to Watch" list populated for the app to function properly.
  • Feel free to customize the UI and add new features to enhance your experience.

Project Contributers:

🎉 Happy Watching!

Let Kushiro guide your next anime journey! 🌟