An open API service indexing awesome lists of open source software.

https://github.com/notstark/animedex-react


https://github.com/notstark/animedex-react

anime anime-streaming reactjs streaming streaming-video typescript

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# AnimeDex
Welcome to AnimeDex Project, a small project created for learning purpose. This project is an open-source and free to use. If you have any kind of issue or suggestion, feel free to create an issue or pull request 😁.

## Features
- No ads
- Watch list functionality
- Dark mode
- and many more...

## Installation

If you want to run this project in your local machine, follow these steps:

1. Clone the repository `git clone https://github.com/NotStark/Animedex-React.git`
2. Navigate to project directory `cd Animedex-React`
3. Install dependencies `npm install`
4. Start the server `npm run dev`
5. Open your browser and go to `http://localhost:5173`

## Acknowledgement
this repo utilizes [AnimedexApi](https://github.com/TechShreyash/AnimeDexApi) to show anime data in its site.

## Contributing
Contributions are always welcome! If you want to contribute to this project, please follow these steps:

1. Fork the project
2. Create your feature branch `git checkout -b feature/new-feature`
3. Commit your changes `git commit -m 'Add new feature'`
4. Push to the branch `git push origin feature/new-feature`
5. Create a new pull request

## License
This project is licensed under the MIT License. See the [LICENSE](./LICENCE) file for details.