Home Library Service

Prerequisites

• Git - Download & Install Git
• Node.js - Download & Install Node.js and the npm package manager
• Docker Desktop - Download & Install Docker

Installation

1. Clone the repository:

git clone https://github.com/seygorin/nodejs2024Q3-service
cd nodejs2024Q3-service

2. Change .env file in the root directory if you want to change the default port or database credentials.

Running Application

Using Docker (Recommended)

1. Build and start containers:

npm run docker:build  # Build containers
npm run docker:up     # Start containers and wait a bit

2. View logs:

npm run docker:logs

3. Access services:

• API: http://localhost:4000 (default)
• Swagger UI: http://localhost:4000/api
• Prisma Studio: http://localhost:5555 (after running npm run prisma:studio)

4. Stop application:

npm run docker:down

Using Local Environment

1. Install dependencies:

npm install

2. Start the application:

npm run start        # Production mode
npm run start:dev    # Development mode with watch

Database Management

Access and manage database using Prisma Studio:

npm run prisma:studio

Generate Prisma client after schema changes:

npm run prisma:generate

Testing

Run tests:

npm run test         # Run all tests without authorization

Code Quality

Format and lint code:

npm run format  # Format code using Prettier
npm run lint    # Lint and auto-fix using ESLint

Security

Scan for vulnerabilities:

npm run scan

API Documentation

After starting the application, you can explore the API documentation:

• Swagger UI: http://localhost:4000/api
• OpenAPI specification: Available in /doc folder (api.yaml and api.json)

Docker Image

The application image is available on Docker Hub:

docker pull seygorin/nodejs2024q3:latest

Or by link.