Otakle

The wordle for anime lovers (otakus)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Note on re-sharing
7. License
8. Contact
9. Acknowledgments

About The Project

Otakle is a fun and engaging word puzzle game designed for anime enthusiasts. Similar to Wordle, players guess anime-related words within a limited number of tries. Enjoy testing your anime knowledge with friends and fellow otakus!

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

This section will guide you through setting up Otakle on your local machine and getting started with guessing anime words.

Prerequisites

• A modern web browser with WebAssembly support (most recent versions of popular browsers like Chrome, Firefox, and Edge should work).
• Node.js and npm (or yarn) installed on your system for running the Next.js development server. This is an example of how to list things you need to use the software and how to install them.

  npm install npm@latest -g

Local Development

1. Clone the repo

   git clone https://github.com/SkaiLord/otakle.git

2. Navigate to the project directory:

   cd otakle

3. Install NPM packages

   npm install

4. Run the development server:

   npm run dev

(back to top)

Usage

Visit https://otakle.vercel.app to start playing the game. Guess the anime-related word within the given attempts and share your results with friends!

(back to top)

Roadmap

• Meta data + SEO
• Light Theme UI
• Success animation
• Share link feature
• State Management - Zustand
• Multi-lingual

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Note on re-sharing

I have been refining the project using 2+ years of my learnings. While I appreciate the beauty of open source, due credits to the project will be appreciated if you plan to re-share the template. Copyright headers with author name should be included under the forked versions as well. Happy coding 😄

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sahir Khan - @SkaiLord007 - skailord007@gmail.com

Project Link: https://github.com/SkaiLord/otakle

(back to top)

Acknowledgments

• Next.js
• React Icons
• Tailwind Css
• Shadcn/ui

(back to top)