genshin-api

Genshin public REST API serving data from a Web Scraping approach

API Docs

Environment	Swagger Online Docs
Production

Roadmap

Feature	Endpoint	Status
Puppeteer Setup	-	✅
Database Setup	-	✅
Docker Setup	-	✅
Public Swagger	GET /docs	✅
Signup	POST /api/v1/auth/register	✅
Login	POST /api/v1/auth/login	✅
Characters List	GET /api/v1/characters	✅
Character Details	GET /api/v1/characters/:id	✅
Deploy v0.1.0	https://genshin-api.santospatrick.com/docs	✅

Development

1. Setup a PostgreSQL database (example with docker):

docker run --name database -e POSTGRES_PASSWORD=root -p 5432:5432 -d postgres

2. Duplicate .env.example to .env fulfilling variables as needed

3. Run the following commands:

yarn install
yarn adonis key:generate
yarn adonis migration:run
yarn dev

4. Done 🎉 (access http://localhost:3333)

Production

1. Clone this repo:

git clone git@github.com:santospatrick/genshin-api.git

2. Duplicate .env.example to .env fulfilling variables as needed

cp .env.example .env
vim .env
# edit variables

3. Run docker-compose and migrations:

docker-compose up -d
docker exec -it YourAppName sh
yarn adonis key:generate
yarn adonis migration:run

4. Done 🎉

Postman

Download project's postman collection to test endpoints