README.md

DodoApi

Description

DodoApi is an under construction RESTful API for Animal Crossing New Horizons game.

Current and next steps

• Add endpoint for Fishes.
  • Build initial route implementation
  • Add documentation
  • Add tests
  • Deploy
• Add endpoint for Insects.
• Add endpoint for Sea Creatures.
• Add endpoint for Artworks.
• Add endpoint for Clothes.
  ...
• Add more endpoints for other New Horizon's topics.
  ...
• Add data for other Animal Crossing games.

Installation

$ yarn install

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Support and Credits

The current data was obtained from ACNH Community Spreadsheet. You can also find more information about it in Nookipedia's FAQ page.

This API is built using Nest framework. Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - André Scheibel de Almada

License

DodoApi is BSD 3-Clause licensed.