One Piece TCG API

One Piece trading card game (TCG) REST API built with Nest.js framework.

Description

Nest TypeScript repository Mongo database JWT authentication, and Swagger (NestJS Swagger) documentation. The cards in the production database are up to OP-07.

Project setup

To use this project for your own card database, we suggest using a card scraper or entering the cards manually.
At the time of development, we used this card scraper from Seitrox.

$ npm install
# place a JSON with the scrapped cards in /src/scripts/importCards
$ npm run import:cards

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

Resources

Once the project is already setted up and running, you can check the Swagger documentation in the root (/) route of the project

Credit

Authors

• Iker Gonzalez Tirado LinkedIn, GitHub

License

Nest is MIT licensed.