Skip to content

clowns-party/animeover

Repository files navigation

Logo

@clownsparty/animeoverapi

The pet project is like a website with a database of anime series and
movies, with the ability to add a user to the list.

The basis of the database was to take the anime-offline-database.json from manami-project. This repository is
released as a backend part of the project.


-----------------------------------------------------


➤ Links

production


➤ Launch

1. Requirements

To run project, you need to install Git, Node.js (version >= 14), and Yarn package manager.

  • Git can be installed from the official site: https://git-scm.com/downloads
  • Node.js can be installed from the official site: https://nodejs.org
  • After Node.js is installed, you can run the following command in the console to install Yarn:

$ npm install --global yarn

2. Clone project

Go to the directory where your projects are stored, and run the following command to clone the project code.

$ git clone https://github.com/clowns-party/animeover.git

3. Install project dependencies

Now, go to project folder, and execute in the console:

$ yarn install

4. Create a file based on env.example

FB_APIKEY 
FB_AUTHDOMAIN
FB_PROJECTID
FB_STORAGEBUCKET
FB_SENDERID
FB_APPID=1
FB_MEASUREMENTID
PRIVATE_KEY_ID
PRIVATE_KEY=-----BEGIN PRIVATE KEY-----\n-----END PRIVATE KEY-----\n",
SECURETOKEN_API=console.cloud.google.com take api key

5. Start local development mode

Being in the project directory, execute in the console:

$ yarn generate

Generate swagger and routes.

$ yarn dev

Generate are firebase config and start nodemon.


-----------------------------------------------------

➤ Features

  • Search
  • User anime list
  • Filters
  • Ongoing "integrate with shikimori"
  • Anime list based on anime-offline-database.json
  • Authorization, generate custom token by firebase-admin, generate refresh-token
  • Pagination
  • Rate and review for anime
  • Calendar "integrate with jikan"

-----------------------------------------------------

➤ FAQ

Why is the service not available?

Most likely, the firebase quota has run out, try waiting one day and trying again, since we use the basic plan.

-----------------------------------------------------

➤ Contributors

sieugene dLebrov
Sieugene dLebrov