Animex

Anime browsing wep app created with React/Redux and Jikan API.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This is a Single Page Application (SPA) built with React and Redux to browse and search animes. The design of the web app resembles Netflix. The data is fetched from Jikan API.

Routes:

• / - home page.
• /genre/:genreId/:genreName - genre page.
• /anime/:animeId - anime details page

Features:

• Search anime
• Browse anime
• View anime details

Built With

• React
• Redux
• ESLint
• Stylelint
• SASS
• Styled components
• npm
• Jikan API
• React-burger-menu
• Prop-types
• Netlify

Live demo

Deployed to Heroku - live demo.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/tirthajyoti-ghosh/Animex.git

2. Change directory

   cd Animex

3. Install NPM packages

   npm install

4. Start the local server

   npm start

Roadmap

Check the issues.

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.

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

License

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

Contact

👤 Tirthajyoti Ghosh

• Website: ghosh.tech
• GitHub - @tirthajyoti-ghosh
• Twitter - @terrific_ghosh
• LinkedIn - @tirthajyoti-ghosh

Acknowledgements

• Design inspirations
  • Netflix-Redesign-challenge-on-Uplabs
  • Netflix-Redesign-Idea
• README Icon from Icons8
• Img Shields
• Font Awesome