@@ -52,15 +52,69 @@ let's start with
5252
5353## Usage
5454
55- - You need node .js 18.x or 20.x
55+ - You need Node .js 18.x or higher (24.x preferred)
5656- Fork and clone this repository (optionally subscribe to repo changes)
5757- Run ` npm i ` to install dependencies and generate RSA certificate
5858- Remove unneeded dependencies if your project doesn't require them
5959- Add your license to ` LICENSE ` file but don't remove starter kit license
6060- Start your project modifying this starter kit
61- - If you have Docker and Docker Compose installed to run the project, use the command: ` docker-compose up `
61+
62+ ## Docker Usage
63+
64+ The easiest way to run this application is using Docker and Docker Compose:
65+
66+ ### Prerequisites
67+
68+ - Docker and Docker Compose installed
69+ - No need to install PostgreSQL or Redis locally
70+ - Uses PostgreSQL 17 (latest stable) and Redis 8
71+
72+ ### Quick Start
73+
74+ ``` bash
75+ # Start all services (API, PostgreSQL, Redis)
76+ docker-compose up
77+
78+ # Start services in background (detached mode)
79+ docker-compose up -d
80+
81+ # Stop all services
82+ docker-compose down
83+
84+ # View logs
85+ docker-compose logs
86+
87+ # View logs for specific service
88+ docker-compose logs api-example
89+ docker-compose logs pg-example
90+ docker-compose logs redis-example
91+
92+ # Rebuild and start services
93+ docker-compose up --build -d
94+ ```
95+
96+ ### Access Points
97+
98+ - ** Main Application** : http://localhost:8002/ (Metarhia Console)
99+ - ** API Endpoints** : http://localhost:8001/api/
100+ - ** Load Balancer** : http://localhost:8000/ (redirects to 8002)
101+
102+ ### Service Status
103+
104+ ``` bash
105+ # Check running services
106+ docker-compose ps
107+
108+ # Restart a specific service
109+ docker-compose restart api-example
110+ ```
111+
112+ ## Manual Installation (Alternative)
113+
114+ If you prefer to run without Docker:
115+
62116- Before running server initialize the DB:
63- - First of all, make sure you have PostgreSQL installed (preferably 12 .x to 16 .x).
117+ - First of all, make sure you have PostgreSQL installed (preferably 15 .x to 17 .x).
64118 - Run database initialization script: ` database/setup.sh `
65119- Run project: ` node server.js ` and stop with Ctrl+C
66120- Ask questions in Telegram https://t.me/nodeua (node.js related) or
0 commit comments