/nest-brewery

learning nestjs+typeorm+typescript

Primary LanguageTypeScript

Welcome to nest-brewery 👋

Version

API for a brewery to keep track of Beers

Pre Install

Edit the ormconfig.json file to reflect which database you will use. I used postgres and it worked great.

Install

npm install

Usage

npm run start

Run tests

npm run test

API Endpoints

GET

/

Redirects to Swagger documentation

GET

/api

Swagger documentation

GET

/get

Returns all beers in the database

POST

/post

Creates a new beer with mandatory parameters beerName and ABV

GET

/get/ABV=:ABV

Returns all beers with the specific ABV passed as parameter

GET

/get/minABV=:minABV&maxABV=:maxABV

Returns all beers with ABV between minABV and maxABV parameters

Author

👤 Yannick Vindevoghel