mirror of https://github.com/aruppi/aruppi-api
160 lines
6.4 KiB
Markdown
160 lines
6.4 KiB
Markdown
# **Aruppi API** (v4.2.2)
|
|
|
|
> 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)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
<img src="./assets/img/cover.png" width="100%" alt="">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
## **:wrench: Developer usage**
|
|
|
|
### **Set up project**
|
|
|
|
Before cloning the repo **be sure** you have installed:
|
|
|
|
- [**NODE**](https://www.google.com/search?q=how+to+install+node) (version >= 12.17.x)
|
|
|
|
In your package manager you can use either **yarn** or **npm**,
|
|
you need to have installed these versions:
|
|
|
|
- [**NPM**](https://www.google.com/search?q=how+to+install+npm) (version >= 6.14.x)
|
|
- [**YARN**](https://www.google.com/search?q=how+to+install+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
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
```bash
|
|
yarn start
|
|
```
|
|
|
|
### Build the Project
|
|
|
|
```bash
|
|
npm build
|
|
```
|
|
|
|
```bash
|
|
yarn build
|
|
```
|
|
|
|
### Test the project
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
```bash
|
|
yarn test
|
|
```
|
|
|
|
## 📖 API Documentation
|
|
|
|
**Documentation coming soon** at the following link: [**Aruppi Wiki**](https://github.com/aruppi/aruppi-api/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**](https://github.com/aruppi/aruppi-api/tree/v2) and [**v3.x.x**](https://github.com/aruppi/aruppi-api/tree/v3). 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**](https://github.com/aruppi/aruppi-api-v1)
|
|
|
|
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**](https://aruppi.jeluchu.com/download)
|
|
|
|
### **📚 Projects that use the API**
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://aruppi.jeluchu.com/">
|
|
<img src="https://avatars2.githubusercontent.com/u/38753425?s=200&v=4" width="75px;" alt="Jeluchu"/><br />
|
|
<sub>
|
|
<b>Aruppi</b>
|
|
</sub>
|
|
</a><br/>
|
|
<sub>Anime y Manga</sub>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/Fmaldonado6/Akiyama">
|
|
<img src="https://raw.githubusercontent.com/Fmaldonado6/Akiyama/master/images/logo/logo.png" width="75px;" alt="Jeluchu"/><br />
|
|
<sub>
|
|
<b>Akiyama</b>
|
|
</sub>
|
|
</a><br/>
|
|
<sub>Web and App</sub>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Contributors ✨
|
|
|
|
Here are the **main contributors to the API**, along with Aruppi's creator
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center"><a href="https://github.com/Jeluchu"><img src="https://avatars.githubusercontent.com/u/32357592?v=4" width="100px;" alt=""/><br /><sub><b>Jéluchu</b></sub></a><br /><a href="https://www.instagram.com/jeluchu/" title="Instagram">📸</a> <a href="https://about.jeluchu.com/" title="About Jelu">🌍</a> <a href="https://twitter.com/Jeluchu" title="Twitter">📢</a><a href="https://www.linkedin.com/in/jesusmariacalderon/" title="LinkedIn">🔍</a></td>
|
|
<td align="center"><a href="https://github.com/capitanwesler"><img src="https://avatars.githubusercontent.com/u/61250854?v=4" width="100px;" alt=""/><br /><sub><b>Guillermo</b></sub></a><br/><a href="https://www.facebook.com/profile.php?id=100009163736196" title="Facebook">👀</a> <a href="mailto:guillermo.campanudo@hotmail.com" title="E-mail">📧</a> <a href="https://www.linkedin.com/in/guillermo-campanudo/" title="LinkedIn">🔍</a></td>
|
|
<td align="center"><a href="https://github.com/Darkangeel-hd"><img src="https://i.pinimg.com/564x/24/73/c0/2473c02e2ac93f617a28b2b5058bb41d.jpg" width="100px;" alt=""/><br /><sub><b>Darkangeel-hd</b></sub></a><br /><a href="https://i.pinimg.com/originals/19/41/22/1941222eaee4de7d08dc21cc3993e791.jpg" title="Let's All Love lain!">👀</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
There are also **people who have made contributions** and therefore it is also important to highlight them.
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center"><a href="https://github.com/Fmaldonado6"><img src="https://avatars.githubusercontent.com/u/28517542?v=4" width="100px;" alt=""/><br /><sub><b>Fmaldonado6</b></sub></a><br/></td>
|
|
<td align="center"><a href="https://github.com/HernanSsj"><img src="https://avatars.githubusercontent.com/u/41026227?v=4" width="100px;" alt=""/><br /><sub><b>HernanSsj</b></sub></a><br/></td>
|
|
</tr>
|
|
</table>
|
|
|
|
#
|
|
|
|
### **:busts_in_silhouette: Credits**
|
|
|
|
- [Darkangeel](https://github.com/Darkangeel-hd) (System administration authority (SYSADM))
|
|
- [Jéluchu](https://github.com/Jeluchu) (Multiplatform Developer, designer, and others)
|
|
- [Capitanwesler](https://github.com/capitanwesler) (Backend developer, web developer and others)
|
|
|
|
Copyright © 2022 [Jéluchu](https://about.jeluchu.com/).
|