Skip to content

Aruppi API has everything about Japan, from anime, music, radio, images, videos ... to japanese culture

License

Notifications You must be signed in to change notification settings

jeluchu/aruppi-api

 
 

Repository files navigation

Aruppi API (v4.2.0)

This API has everything about Japan, from anime, music, radio, images, videos ... to japanese culture

These are the services used for the Aruppi App (only available in Spanish language)

node version npm version yarn version type code maintenance now gitrepo

     

     

Aruppi API has been developed to bring together all the information about Japanese culture, from anime and manga to the most secret places in Japan, its gastronomy and even its festivities.

We are in continuous development to implement more features and improvements in the functioning of it, to later implement it in the mobile application.

🔧 Developer usage

Set up project

Before cloning the repo be sure you have installed:

  • NODE (version >= 12.17.x)

In your package manager you can use either yarn or npm, you need to have installed these versions:

  • NPM (version >= 6.14.x)
  • YARN (version >= 1.22.x)

Then:

  • Choose a folder project in your system and switch in cd [folder path]
  • Clone the repo in your folder path git clone https://github.com/aruppi/aruppi-api.

Here are the steps to get started with the project on both platforms, use the corresponding commands if npm or yarn.


Installation

In order to install the project and all dependencies, enter in the project folder and run npm install or you can do the same with yarn with yarn in the project


Start the project

npm start
yarn start

Build the Project

npm build
yarn build

Test the project

npm test
yarn test

📖 API Documentation

Documentation coming soon at the following link: Aruppi Wiki Where we will show more information about the calls and queries together with the response obtained or the different types of variables in some of the queries.

Countdown to deprecation of v3 API

Aruppi API version 3.x.x has been deprecated, that's why all of you who are using it should migrate as soon as possible to version 4.x.x which we have already released.

Otherwise, if you want to use older versions you can host them yourself on your servers, and download the code in the corresponding branches of v2.x.x and v3.x.x. In case you want to use an even lower version of the API we recommend you to have a look at this other version v1.x.x

Currently the Aruppi app on Android is already using the v4.x.x API services from version v2.0.8, which you can download from our website: Download Aruppi App

📚 Projects that use the API

Jeluchu
Aruppi

Anime y Manga
Jeluchu
Akiyama

Web and App

Contributors ✨

Here are the main contributors to the API, along with Aruppi's creator


Jéluchu

📸 🌍 📢🔍

Guillermo

👀 📧 🔍

Darkangeel-hd

👀

There are also people who have made contributions and therefore it is also important to highlight them.


Fmaldonado6


HernanSsj

👥 Credits

  • Darkangeel (System administration authority (SYSADM))
  • Jéluchu (Multiplatform Developer, designer, and others)
  • Capitanwesler (Backend developer, web developer and others)

Copyright © 2022 Jéluchu.

Packages

No packages published

Languages

  • TypeScript 99.1%
  • Other 0.9%