Skip to content

nilotpaul/animelist-app

Repository files navigation

Welcome to AnimePulse - AnimeList App

AnimePulse offers a feature-rich platform for anime enthusiasts. Users can browse, track, and manage their anime watchlists, write reviews, explore anime information, and track their anime-watching progress. Whether you're a seasoned anime fan or just getting started, this app is designed to elevate your anime experience.

Table of Contents

Features

Anime Management

  • Anime Lists: Users can add anime they've watched to their watchlist and completed list and more.
  • Filter and Search: Easily filter and search for anime by title, genre, or keyword.

User Interaction

  • User Registration: Users can create accounts to access the app's features.

Anime Information

  • Anime Details: Access detailed information about each anime, including episodes, synopsis, and staff details.
  • Reviews: Users can write and read anime reviews.

Responsive Design

  • The app is designed to work seamlessly on both desktop and mobile devices.

Demo

You can access a live demo of the AnimeList App at https://animepulse.vercel.app

Installation

To run the AnimeList App locally, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/nilotpaul/animelist-app.git
  2. Change into the project directory:

    cd animelist-app
  3. Install the required dependencies:

    npm install
  4. Start the development server:

    npm run dev
  5. Open your web browser and access the app at http://localhost:5173.

Usage

User Registration and Login

  1. Registration: New users can register by providing their email and creating a password.

  2. Login: Registered users can log in with their credentials.

Managing Anime Lists

  1. Adding Anime: After logging in, users can add anime they've watched to their watchlist.

Filtering and Searching Anime

  1. Filtering: Use the filter options to narrow down your anime search by type, popularity, or other criteria.

  2. Searching: Enter keywords in the search bar to find specific anime titles or information.

Exploring Anime Details

  1. Anime Details: Click on an anime title to access detailed information, including:
    • Episodes
    • Synopsis
    • Staff details

Writing Reviews

  1. Writing Reviews: Users can write reviews for anime they've watched. Share your thoughts and ratings with the community.

Contributing

We welcome contributions from the open-source community! If you'd like to contribute to the AnimeList App, please follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/new-feature or git checkout -b bug/bug-fix.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your fork: git push origin feature/new-feature.
  5. Open a pull request on the main repository, describing your changes and their purpose.

License

The AnimeList App is open-source software released under the MIT License. Feel free to use, modify, and distribute the app as per the terms of the license.