Containerization, Docker

.dockerignore

@@ -0,0 +1,8 @@
+node_modules
+Dockerfile
+.dockerignore
+.git
+.gitignore
+dist
+test
+pgdata

.env.example → .env

@@ -1,5 +1,11 @@
 PORT=4000
 
+POSTGRES_PORT=5432
+
+POSTGRES_USER=admin
+POSTGRES_PASSWORD=postgresadmin
+POSTGRES_DB=postgresdb
+
 CRYPT_SALT=10
 JWT_SECRET_KEY=secret123123
 JWT_SECRET_REFRESH_KEY=secret123123

.gitignore

@@ -1,6 +1,7 @@
 # compiled output
 /dist
 /node_modules
+/pgdata
 
 # Logs
 logs

Dockerfile

@@ -0,0 +1,8 @@
+FROM node:16-alpine
+WORKDIR /usr/app
+COPY package*.json .
+RUN npm ci
+COPY . ./
+ENV PORT 4000
+EXPOSE $PORT
+CMD ["npm", "run", "start:dev"]

README.md

@@ -1,72 +1,117 @@
 # Home Library Service
 
+Home Library Service is REST API offering Create, Read, Update, and Delete (CRUD) handlers.
+
 ## Prerequisites
 
 - Git - [Download & Install Git](https://git-scm.com/downloads).
 - Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
+- Docker - [Download & Install Docker](https://www.docker.com/get-started/).
+
+## Installation
 
-## Downloading
+- Clone this repository
 
 ```
-git clone {repository URL}
+git clone {repository}
 ```
 
-## Installing NPM modules
+- Go to `nodejs2022Q2-service`
 
 ```
-npm install
+cd nodejs2022Q2-service
 ```
 
-## Running application
+- Install all dependencies
 
 ```
-npm start
+npm install
 ```
 
-After starting the app on port (4000 as default) you can open
-in your browser OpenAPI documentation by typing http://localhost:4000/doc/.
-For more information about OpenAPI/Swagger please visit https://swagger.io/.
+- Start application in production mode
 
-## Testing
+```
+npm run start:prod
+```
 
-After application running open new terminal and enter:
+- After starting the app on port (4000 as default) you can open
+  in your browser OpenAPI documentation by typing http://localhost:4000/doc/.
 
-To run all tests without authorization
+### Run App with Docker
 
 ```
-npm run test
+docker-compose up
 ```
 
-To run only one of all test suites
+### Download Docker Images
+
+[See on Docker hub](https://hub.docker.com/repository/docker/marieserykh/nodejs2022q2_service)
 
 ```
-npm run test -- <path to suite>
+docker pull marieserykh/nodejs2022q2_service:app
 ```
 
-To run all test with authorization
-
 ```
-npm run test:auth
+docker pull marieserykh/nodejs2022q2_service:postgres
 ```
 
-To run only specific test suite with authorization
+
+### Vulnarability scanning
 
 ```
-npm run test:auth -- <path to suite>
+npm run scan:app
 ```
 
-### Auto-fix and format
-
 ```
-npm run lint
+npm run scan:db
 ```
 
+
+## Usage
+
+### Routing
+
+Collections are: `user`, `album`, `artist`, `track`, `favs`
+
+- `GET` `/{collection}`: Returns all resources of this collestion
+
+- `POST` `/{collection}`: Creates a resource of the collection, then returns with ID
+
+- `POST` `/favs/album/:id`: Adds an album to favourites
+- `POST` `/favs/artist/:id`: Adds an artist to favourites
+- `POST` `/favs/track/:id`: Adds a track to favourites
+
+- `PUT` `/{collection}/:id`: Updates the resource of the collection with that ID
+
+- `DELETE` `/{collection}/:id`: Deletes the resource of the collection with that ID
+
+- `DELETE` `/favs/album/:id`: Deletes the album from favourites
+- `DELETE` `/favs/artist/:id`: Deletes the artist from favourites
+- `DELETE` `/favs/track/:id`: Deletes the track from favourites
+
+### HTTP status codes
+
+- `201` when creating
+- `200`  when getting and updating
+- `204` when deleting
+- `400` when trying to get a non-existant resource (id)
+- `400` when providing invalid id (not uuid) or invalid request body
+- `403` when providing incorrect old password
+- `404` if either the collection of data you are POSTing to (e.g. genre in the URLs) is unknown or you are trying to get a non-existant resource (id)
+- `422` when providing a reference in request body to a non-existant resource
+
+## Testing
+
+After application running open new terminal and enter:
+
+- to run all tests without authorization
+
 ```
-npm run format
+npm run test
 ```
 
-### Debugging in VSCode
+- to run only one of all test suites
 
-Press <kbd>F5</kbd> to debug.
-
-For more information, visit: https://code.visualstudio.com/docs/editor/debugging
+```
+npm run test -- <path to suite>
+```

db/Dockerfile

@@ -0,0 +1 @@
+FROM postgres:alpine