API made with NestJS using an hexagonal approach on the architecture to fetch pokemon data for a React-Native project serving as a BFF for it. Mobile project link pokedex-reactnative.
Since I'm creating a new BFF based on a pre-existing API, I thought it was also interesting to have an ER mapping for our SQLite database. Here you can access my ER diagram stored in google drive.
-
You need to configure your
.envor host environment variables in order to connect to the database. -
Install the project dependencies.
# dependencies installation
$ yarn- Then run the docker container which will serve the app.
# run docker container on port default 3000 in development mode
$ docker-compose upYou can run the following commands to test the application.
# unit tests
$ npm run test
# test coverage
$ npm run test:cov💡 Important thing to notice is that a new html file in
/coverage/lcov-report/index.htmlcontaining more about the results.
- Add containerization with docker.
- Add enviroment variables.
- Organize project structure using a more hexagonal approach.
- Add downloadable pokemons endpoint.
- Add unity tests.
- Add pokemon details endpoint.
- Add swagger for API Documentation.
- Configure custom paths for file imports.
- Author - Stefano Soro