Anime Recommender

This project is a fullstack anime recommendation system, with a backend/api that currently uses our own system to recommend anime based on a single anime given as input.


View Live · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

(back to top)

Built With

• React.js
• Typescript
• Flask
• Firebase
• RapidAPI

(back to top)

Getting Started

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

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Setup a Firebase project at https://firebase.google.com/

2. Head to our API to get an api key

3. Clone the repo

   git clone https://github.com/fusunnn/animerecommender

4. Install the packages

   yarn install

5. Enter your Firebase project data in .env - a boilerplate for this is available in the .env.example --> to use it modify the file's name to .env and add in your own keys

   REACT_APP_API_KEY=
   REACT_APP_AUTH_DOMAIN=
   REACT_APP_PROJECT_ID=
   REACT_APP_STORAGE_BUCKET=
   REACT_APP_MESSAGING_SENDER_ID=
   REACT_APP_APP_ID=
   REACT_APP_MEASUREMENT_ID=
   
   REACT_APP_RAPID_API_KEY=

6. Run the project

   yarn run start
   

(back to top)

Roadmap

• Recommender API - go to our API @ RapidAPI
• Website - Head to our website AnimeRecommender to check out the website live,
• Account system - Every time you ask for a recommendation, the anime you inputed for reference will be saved as a liked anime
• Themeing System - Make use of our set of 4 themes that are saved to both your browser and your account (if you have one) - all themes were pulled from Monkeytype

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)

License

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

(back to top)

Contact

fusunnn - @audouard_ivan - i.audouard22@ejm.org

erni12345 - LinkedIn - ernestodemenibus@gmail.com

Project Link: https://github.com/fusunnn/animerecommender

(back to top)