Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hirwa13/iluvecoffee
A Nest JS Playground
https://github.com/hirwa13/iluvecoffee
Last synced: 17 days ago
JSON representation
A Nest JS Playground
- Host: GitHub
- URL: https://github.com/hirwa13/iluvecoffee
- Owner: HIRWA13
- Created: 2023-12-05T14:25:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-19T08:28:26.000Z (about 1 year ago)
- Last Synced: 2023-12-19T11:35:00.521Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 136 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
## Nest JS Playground
This is my playground for Nest JS. It is a simple API of a coffee store.
you can create, update, delete and get all coffees or a specific coffee.
with the help of a docker container you can access the postgres database with the following command:
```bash
docker-compose up -d ## -d helps docker to run in the background
```
Docker is an open platform for developing, shipping, and running applications. It helps you to run your application in a containarized mode.
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Project Preview
to preview the project and the functionality, you can use Postman or Insomnia to test the API.
the application runs on localhost:3000 by default.
```bash
## to create a new coffee
POST localhost:3000/coffees
{
"name": "coffee name",
"brand": "coffee brand",
"flavors": ["coffee flavor"]
}
## to get all coffees
GET localhost:3000/coffees
## to get a specific coffee
GET localhost:3000/coffees/:id
## to update a specific coffee
PATCH localhost:3000/coffees/:id
{
"name": "coffee name",
"brand": "coffee brand",
"flavors": ["coffee flavor"]
}
## to delete a specific coffee
DELETE localhost:3000/coffees/:id
```
## Stay in touch
- Author - [Junior Hirwa](https://github.com/HIRWA13)