An open API service indexing awesome lists of open source software.

https://github.com/grootkng/clean-arch-js


https://github.com/grootkng/clean-arch-js

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README

          

Clean Arch with Javascript

## Instalation and Usage

### Must have
1. Node.js v18
2. Docker

### Step-by-step without docker
1. Copy the content of `.env.example` and paste in a file called `.env`
2. Instal the dependencies: `npm install`
3. Run a Postgres database with the configs in the `.env.example`
4. Run the migrations: `db:migrate`
3. Then run the project: `npm run start`. Or with watch mode: `npm run start:dev`

### Step-by-step with docker
1. Copy the content of `.env.example` and paste in a file called `.env`
2. Run: `docker-compose up`

### URLs
* (GET and POST) localhost:8000/notes
* (GET) localhost:8000/notes?author=[AuthorNameHere]
* (GET) localhost:8000/notes/?id=[NoteIdHere]