edu18RR / naruto-api

Like a Pokédex but for Naruto. API to fetch data about Naruto (and Boruto) anime and manga. With a short resume of history of life, images and a table of more specific information of each character.

Home Page:https://gustavonobreza.github.io/naruto-api/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NodeJS NestJS TypeScript FlyIO

Build status: Passing Build status: Passing

Description

API to fetch data about Naruto (and Boruto) anime and manga. With a short resume of history of life, images and a table of more specific information of each character.

Deploy

It's deployed on Fly.io: https://naruto-api.fly.dev/

Links

Installation

$ pnpm install

Running the app

# development
$ pnpm start

# watch mode
$ pnpm start:dev

# production mode
$ pnpm start:prod

Test

# unit tests
$ pnpm test

# e2e tests
$ pnpm test:e2e

# test coverage
$ pnpm test:cov

Source

This app use from behind a json file generated using a crawler from Narutopedia. All the information is from there, photos (more information at #Photos ), articles, tables, and so on.

Photos

When using the Narutopedia link, I was having some bugs so I downloaded all the photos and served using supabase.

Paths

Path Source Method Respose Queries
/api/v1 characters GET All characters soon
/api/v1 characters/:id GET One character by id --
/api/v1 clans GET All clans soon
/api/v1 clans/:id GET One clan by id --
/api/v1 bijus GET All bijus --

About

Like a Pokédex but for Naruto. API to fetch data about Naruto (and Boruto) anime and manga. With a short resume of history of life, images and a table of more specific information of each character.

https://gustavonobreza.github.io/naruto-api/

License:MIT License


Languages

Language:TypeScript 95.7%Language:JavaScript 4.2%Language:Procfile 0.1%