# **Aruppi API** (v5.0.0) (Preview release)
> 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)
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
## Prerequisites
- **JDK 21** or higher installed.
- **Gradle** installed (although Ktor can use the Gradle wrapper).
- **Git** for cloning the repository.
- **Docker Compose** installed on your local machine.
- For an easy installation, consider using **Docker Desktop**, which includes Docker Compose. Download it from [Docker Desktop](https://www.docker.com/products/docker-desktop/).
- A **server** or cloud service to deploy the application (e.g., Heroku, AWS, DigitalOcean).
## Install IntelliJ IDEA Community Edition
Download and install **IntelliJ IDEA Community Edition** from the official JetBrains website: [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download)
**Instructions:**
1. Visit the [IntelliJ IDEA download page](https://www.jetbrains.com/idea/download).
2. Click on the **Download** button under the **Community** edition.
3. Once downloaded, open the installer and follow the on-screen instructions to complete the installation.
### **Set up project**
#### Clone project
```bash
git clone https://github.com/aruppi/aruppi-api.git
cd aruppi-api
```
#### Configure the Environment
Create a `.env` file or set the necessary environment variables for your application, such as:
```
MONGO_CONNECTION_STRING=mongodb://user:password@host:port
MONGO_DATABASE_NAME=aruppi
```
You will be able to find an `example.env` file in the project, simply rename the file by removing ‘example’ and edit the variables
---
### Build the Project
#### Build the Services
Run the following command in the root directory of your project to build the Docker images:
```bash
docker-compose build
```
#### Start the Services
Start the application and the database using Docker Compose:
```bash
docker-compose up -d
```
Explanation:
- `up`: Creates and starts the containers.
- `-d`: Runs the containers in detached mode.
#### Verify the Services are Running
To check if the services are running correctly, use:
```bash
docker-compose ps
```
You should see output similar to:
| NAME | IMAGE | COMMAND | SERVICE | CREATED | STATUS | PORTS |
|----------|----------------|----------------------|---------|----------------|--------------|------------------------|
| ktor_app | aruppi-api-app | "/app/entrypoint.sh" | app | 19 seconds ago | Up 2 seconds | 0.0.0.0:8080->8080/tcp |
Additionally, you can view the logs to ensure the application has started without errors:
```bash
docker-compose logs -f app
```
## API Documentation
The API documentation is included within the API. If you want to:
- **Consult the endpoints**
- **Perform tests**
- **See the types of responses**
Simply navigate to [http://0.0.0.0:8080/api/v5/](http://0.0.0.0:8080/api/v5/) to view the complete documentation.
## Countdown to deprecation of v3 API
Aruppi API version 4.x.x has been deprecated, that's why all of you who are using it should migrate as soon as possible to version 5.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 v5.x.x API services from version v3.0.0, which you can download from our website: [**Download Aruppi App**](https://aruppi.jeluchu.com/download)
### **📚 Projects that use the API**
## Contributors ✨
Here are the **main contributors to the API**, along with Aruppi's creator
There are also **people who have made contributions** and therefore it is also important to highlight them.
#
### **: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/).
