chore: rename repository

updated README
added redis.conf for docker

Author: neverovski

.cloud/redis.conf

@@ -0,0 +1,11 @@
+# Enable persistence
+appendonly yes
+appendfsync everysec
+
+# Snapshotting (adjust as needed)
+save 900 1
+save 300 10
+save 60 10000
+
+# AOF (Append-Only File) configuration
+appendfilename "appendonly.aof"

README.md

@@ -1,18 +1,55 @@
-# Basic Authentication for Nodejs
+# Node.js Rest API
 
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](http://prettier.io) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
 
-This project, titled "Basic Authentication for Nodejs", is a comprehensive authentication solution built with Node.js. It includes features such as user authentication, token refresh, user logout, password reset, and user management (creation, update, deletion).
+This is a sample Node.js application comprehensive API including features such as user authentication, token refresh, user logout, password reset, and user management (creation, update, deletion).
 
 Additionally, it supports authentication through various platforms including Facebook, Apple, Google, and Github. Twitter and LinkedIn are planned for future integration.
 
 The project also includes a Swagger documentation.
 
+## Features
+  - Auth
+    - [X] Authenticate user
+    - [X] Email verify
+    - [X] Implement "Forgot Password" via email
+    - [] Implement "Forgot Password" via phone
+    - [X] Logout a user
+    - [X] Refresh token
+    - [X] Implement "Reset Password" via email
+    - [] Implement "Reset Password" via phone
+  - User
+    - [X] Create a new user
+    - [X] Update user
+    - [X] Reset password
+    - [X] Delete user
+  - Social Platform Integration
+    - [ ] Linkedin
+    - [ ] Twitter
+    - [X] Apple
+    - [X] Facebook
+    - [X] Github
+    - [X] Google
+  - Testing
+    - [X] Unit
+    - [ ] E2E
+    - [ ] Integration
+  - [X] Implement Swagger for API documentation
+
+## API Documentation
+
+The REST API exposes its OpenAPI. You can view the API definition interactively using the Swagger UI, hosted at /docs. Simply start the server and navigate to [http://127.0.0.1:5858/docs](http://127.0.0.1:5858/docs) in your browser to access the Swagger UI.
+
+Alternatively, you can explore the [online version of the API documentation](https://neverovski.github.io/nodejs-rest-api/) without running the server.
+
+[![openapi](docs/img/openapi.png)](https://neverovski.github.io/nodejs-rest-api/)
+
 ## Installation
 
 Development environment requirements:
-- [Docker](https://www.docker.com) >= 17.06
-- [Docker Compose](https://docs.docker.com/compose/install/)
+- [Node.js](https://nodejs.org) >= 20
+- [Docker](https://www.docker.com) >= 24
+- [Docker Compose V2](https://docs.docker.com/compose/install/)
 
 ## Project initialization
 

docker-compose.yml

@@ -1,11 +1,11 @@
 version: '3.9'
 
 services:
-  auth-server:
-    image: auth-server
-    container_name: auth-server
+  rest-api-server:
+    image: rest-api-server
+    container_name: rest-api-server
     networks:
-      - auth-network
+      - rest-api-network
     build:
       context: .
       dockerfile: ./Dockerfile
@@ -17,25 +17,26 @@ services:
       - ${APP_PORT}:${APP_PORT}
     restart: unless-stopped
 
-  auth-redis:
+  rest-api-redis:
     image: redis:7
-    container_name: auth-redis
+    container_name: rest-api-redis
     networks:
-      - auth-network
-    command: redis-server --save 20 1 --loglevel warning
+      - rest-api-network
+    command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
     volumes:
-      - auth-redis-data:/data
+      - ./.cloud/redis.conf:/usr/local/etc/redis/redis.conf
+      - rest-api-redis-data:/data
     ports:
       - ${REDIS_PORT}:6379
     restart: unless-stopped
 
-  auth-db:
+  rest-api-db:
     image: postgres:15
-    container_name: auth-db
+    container_name: rest-api-db
     networks:
-      - auth-network
+      - rest-api-network
     volumes:
-      - auth-db-data:/var/lib/postgresql/data
+      - rest-api-db-data:/var/lib/postgresql/data
     environment:
       TZ: 'UTC'
       POSTGRES_DB: ${DB_NAME}
@@ -46,11 +47,11 @@ services:
     restart: unless-stopped
 
 volumes:
-  auth-redis-data:
+  rest-api-redis-data:
     driver: local
-  auth-db-data:
+  rest-api-db-data:
     driver: local
 
 networks:
-  auth-network:
-    name: auth-network
+  rest-api-network:
+    name: rest-api-network

docs/img/openapi.png

@@ -1,5 +1,5 @@
 {
-  "name": "nodejs-auth-jwt",
+  "name": "nodejs-rest-api",
   "version": "1.3.0",
   "description": "Node.js for Token Based Authentication (access and refresh) with PostgreSQL database.",
   "index": "src/index.ts",
@@ -38,7 +38,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/neverovski/nodejs-auth-jwt.git"
+    "url": "git+https://github.com/neverovski/nodejs-rest-api.git"
   },
   "author": {
     "name": "Dmitry Neverovski",
@@ -47,13 +47,13 @@
   },
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/neverovski/nodejs-auth-jwt/issues"
+    "url": "https://github.com/neverovski/nodejs-rest-api/issues"
   },
   "engines": {
     "node": "^20",
     "npm": "^10"
   },
-  "homepage": "https://github.com/neverovski/nodejs-auth-jwt#readme",
+  "homepage": "https://github.com/neverovski/nodejs-rest-api#readme",
   "dependencies": {
     "@autotelic/pino-seq-transport": "^0.1.0",
     "@elastic/ecs-pino-format": "^1.5.0",

package.json

@@ -10,7 +10,7 @@ export class SwaggerUtil {
       definition: {
         openapi: '3.0.3',
         info: {
-          title: 'Auth - OpenAPI 3.0',
+          title: 'Node.js Rest API  - OpenAPI 3.0',
           version,
           description,
           contact: author,

src/common/utils/swagger.util.ts

@@ -27,7 +27,7 @@ import { IAuthController, IAuthService } from './interface';
  * @openapi
  * tags:
  *   name: Auth
- *   description: auth
+ *   description: The Auth API provides endpoints for managing user authentication, including login, logout, password reset, and token refresh.
  */
 @Injectable()
 export class AuthController extends ControllerCore implements IAuthController {

src/modules/auth/auth.controller.ts

@@ -21,7 +21,7 @@ import { UserInject } from './user.enum';
  * @openapi
  * tags:
  *   name: User
- *   description: user
+ *   description: The User API provides endpoints for managing user data, including creating, updating, retrieving, and deleting user records.
  */
 @Injectable()
 export class UserController extends ControllerCore implements IUserController {

src/modules/user/user.controller.ts

@@ -3,7 +3,7 @@ const { author, description, version } = require('./package.json');
 module.exports = {
   openapi: '3.0.3',
   info: {
-    title: 'Auth - OpenAPI 3.0',
+    title: 'Node.js Rest API  - OpenAPI 3.0',
     version,
     description,
     contact: author,