Node.js App with PostgreSQL & Redis in Docker

This repository contains a Node.js application that uses PostgreSQL and Redis, and is Dockerized for easy deployment.

I've written a blog on how can you dockerize this Node.js app & run in docker. This reposirity contains the exampke codebase for this blog so check this blog for the better understanbding:

Dockerizing Node.js REST API with Postgres and Redis

Prerequisites

Before running the application, make sure you have Docker installed:

• Docker: Install Docker

Getting Started

Follow these steps to run the Node.js application with PostgreSQL and Redis in Docker:

1. Clone this repository:

   git clone https://github.com/tazbin/blog-website-backend-nodejs-REST-API nodejs-docker

2. Navigate to the repository:

   cd nodejs-docker

3. make a .env file following the format of .env.example file and set the values

4. build docker images & run containers

   docker-compose up --build

5. view running containers

   docker ps

You can stop the running containers anytime using this command

   docker-compose down 

API Endpoints

1. Hello world

• Method: GET
• URL: localhost:3000
• Description: Just shows hello world
• Response status: 200 OK
• Response Payload:

  Hello World!
  

2. Create user

• Method: POST
• URL: localhost:3000/users
• Description: Creates a new user
• Request Payload:

  {
    "name": "Tazbinur",
    "age": 25
  }

• Response status: 200 OK
• Response Payload:

  {
    "id": 1,
    "name": "Tazbinur",
    "age": 25,
    "updatedAt": "2024-04-25T16:24:26.490Z",
    "createdAt": "2024-04-25T16:24:26.490Z"
  }

3. Get user list

• Method: GET
• URL: localhost:3000/users
• Description: Gets list of saved users
• Response status: 200 OK
• Response Payload:

  [
    {
        "id": 1,
        "name": "Tazbinur",
        "age": 25,
        "createdAt": "2024-04-20T18:57:54.001Z",
        "updatedAt": "2024-04-20T18:57:54.001Z"
    },
    {
        "id": 2,
        "name": "Imtiaz",
        "age": 30,
        "createdAt": "2024-04-20T18:58:08.331Z",
        "updatedAt": "2024-04-20T18:58:08.331Z"
    }
  ]