Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/falcucci/pokedex
https://github.com/falcucci/pokedex
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/falcucci/pokedex
- Owner: falcucci
- Created: 2022-11-19T15:42:19.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-25T22:06:58.000Z (almost 2 years ago)
- Last Synced: 2024-07-03T12:10:56.578Z (3 months ago)
- Language: JavaScript
- Homepage: pokedex-falcucci.vercel.app
- Size: 133 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Pokedex Service
A project to consume pokemon info.
___
[](https://api.postman.com/collections/3410852-47bdc30e-6c81-4084-ab8b-cb3ae29e8c82?access_key=PMAT-01GJG5GYFA5NGWGVAFKCW1GN53)
Live Example: https://pokedex-falcucci.vercel.app
Running the service requires some dependencies.
1. Docker or Docker Compose installed. [Install instructions.](https://docs.docker.com/get-docker/)
## Running the service
```bash
docker-compose up -d --build
```
| name | description |
| ---- | ----------- |
| `POKE_API_URL` | poke api endpoint |
| `FUNTRANSLATIONS_API_URL` | fun translations endpoint |
install the dependencies
```bash
npm i
```
Or, run the development server by yourself to check better logs:
```bash
npm run dev
```
Go to http://localhost:3000 to access the serveless functions
Serveless functions are running at https://pokedex-falcucci.vercel.app/api/health
check it out the functions.
```bash
curl --location --request GET 'https://pokedex-falcucci.vercel.app/api/health'
```
GET pokemon by name
```bash
curl --location --request GET 'https://pokedex-falcucci.vercel.app/api/pokemon/ditto'
```
GET legendary pokemon by name
```bash
curl --location --request GET 'https://pokedex-falcucci.vercel.app/api/pokemon/mewtwo'
```
GET pokemon by name legendary translated
```bash
curl --location --request GET 'https://pokedex-falcucci.vercel.app/api/pokemon/translated/mewtwo'
```
# Test Coverage
you can check if everything is fine running the assertions
```bash
npm run test
```
generate coverage
```bash
npm run coverage
```
## Deploy It Yourself 🎉
[](https://vercel.com/import/project?template=https://github.com/falcucci/pokedex)
#### The Node Wayâ„¢
> "When applications are done well, they are just the really application-specific, brackish residue that can't be so easily abstracted away. All the nice, reusable components sublimate away onto github and npm where everybody can collaborate to advance the commons."
