Fixed the project to run using docker compose

Author: codermehraj

README.md

@@ -11,52 +11,24 @@ The project is divided into two main directories:
 - `/client` - Contains the Next.js frontend application.
 - `/server` - Contains the Express.js backend server, which uses Prisma for ORM and PostgreSQL as the database.
 
-## Prerequisites
-
-Before you begin, ensure you have installed:
-
-- Node.js and npm
-- PostgreSQL
-
-## Installation
+## RUNNING THE PROJECT USING DOCKER COMPOSE (RECCOMANDED)
 
 1. Clone the repository:
 
 ```bash
 git clone https://github.com/definecoder/CS24-p2-define-coders.git
 ```
-
-2. Install the dependencies in both the `/client` and `/server` directories:
-
-```bash
-cd EcoSync/client
-npm install
-
-cd ../server
-npm install
-```
-
-## Configuration
-
-In the `/server` & `/client` directory, rename `.env.example` to `.env` and fill in your PostgreSQL database details `with you postgres password e.g: "postgresql://postgres:YOURPASSWORDHERE@127.0.0.1:5432/ecosync"` and other environment variables from [this google doc link](https://docs.google.com/document/d/1j1UFD3U4ejqeDRb26N9WffqvaLzwYYAxGY2OaWlZTO4/edit?usp=sharing).
-
-## Running the Application
-
-1. Start the backend server:
-
+2. Open the source directory in a terminal and give the following command
 ```bash
-cd EcoSync/server
-npm run dev
+docker compose up --build
 ```
+wait for the docker compose to complete and then frontend application will be available running at `http://localhost:3000`, and the backend server will be running at `http://localhost:8585` (or whatever port you specified).
 
-2. In a new terminal window, start the frontend application:
-
+3. After backend and frontend services are running again open the source directory in `another terminal` and give the following command
 ```bash
-cd EcoSync/client
-npm run dev
+docker exec -it backend /bin/bash -c "cd ./src && npx prisma migrate dev --name init && npx prisma db seed 2> /dev/null || echo \'Database is already seeded\'"
 ```
-
-The frontend application will be available at `http://localhost:3000`, and the backend server will be running at `http://localhost:8585` (or whatever port you specified).
+This will do the prisma migration and run the seed file to push initial data.
 
 ## Credentials set by the initial db migration
 
@@ -76,17 +48,30 @@ The frontend application will be available at `http://localhost:3000`, and the b
   }
 }
 ```
-## To run using Docker 
-Go to the source directory and give the following command
-```bash
-docker compose up --build
-```
-## To run using AWS Backend (if docker compose fails)
+
+## RUNNING THE BACKEND USING AWS (IF DOCKER COMPOSE FAILS!)
 Go to `client\data\apiRoutes` and comment the `first line` and uncomment the second
 ```js
 export const baseUrl = "http://localhost:8585"; // Uncomment to run Locally 
 // export const baseUrl = "http://13.250.36.61"; // Uncomment to run in AWS
 ```
+## CONFIGURATION
+In the `/server` & `/client` directory, rename `.env.example` to `.env` and fill in your PostgreSQL database details `with you postgres password e.g: "postgresql://postgres:YOURPASSWORDHERE@127.0.0.1:5432/ecosync"` and other environment variables from [this google doc link](https://docs.google.com/document/d/1j1UFD3U4ejqeDRb26N9WffqvaLzwYYAxGY2OaWlZTO4/edit?usp=sharing).
+
+## RUNNING FRONTEND
+Run the frontend using docker:
+```bash
+docker compose up --build
+``` 
+or locally by running following command:
+```bash
+cd .\client\
+npm i
+npm run dev
+```
+
+
+## NOTE ON USING AWS BACKEND
 When running on AWS the frontend might face some slow network problems which can be fixed by switching speed from no thorttling to fast 3G. [You can check this video to see the demonstration of the problem mentioned here](https://drive.google.com/drive/folders/1B5N5o0ms7mizSYm5HNiAjJj0O82Zb1tq?usp=sharing).
 
 ## License

client/Dockerfile

@@ -1,84 +1,13 @@
+FROM node:latest
 
-# FROM node:latest
+WORKDIR /app
 
-# WORKDIR /usr/src/app
-
-# COPY package*.json ./
-
-# RUN npm install
-
-# COPY . .
-
-# EXPOSE 3000
-
-
-# CMD ["npm", "run", "dev"]
-
-#if not works
-#-------------------
-
-# FROM node:18-alpine as base
-# RUN apk add --no-cache g++ make py3-pip libc6-compat
-# WORKDIR /app
-# COPY package*.json ./
-# EXPOSE 3000
-
-# FROM base as builder
-# WORKDIR /app
-# COPY . .
-# RUN npm run build
-
-
-# FROM base as production
-# WORKDIR /app
-
-# ENV NODE_ENV=production
-# RUN npm ci
-
-# RUN addgroup -g 1001 -S nodejs
-# RUN adduser -S nextjs -u 1001
-# USER nextjs
-
-
-# COPY --from=builder --chown=nextjs:nodejs /app/.next ./.next
-# COPY --from=builder /app/node_modules ./node_modules
-# COPY --from=builder /app/package.json ./package.json
-# COPY --from=builder /app/public ./public
-
-# CMD npm start
-
-# FROM base as dev
-# ENV NODE_ENV=development
-# RUN npm install 
-# COPY . .
-# CMD npm run dev
-
-
-# Use the Ubuntu base image
-# Use the Ubuntu base image
-FROM ubuntu:latest
-
-# Install necessary packages for Node.js and npm
-RUN apt-get update && \
-    apt-get install -y curl && \
-    curl -fsSL https://deb.nodesource.com/setup_20.x | bash - && \
-    apt-get install -y nodejs && \
-    apt-get clean
-
-# Set working directory
-WORKDIR /usr/src/app
-
-# Copy package.json and package-lock.json
 COPY package*.json ./
 
-# Install project dependencies
-RUN npm install --force
+RUN npm install
 
-# Copy the rest of the application files
 COPY . .
 
-# Expose port 3000
 EXPOSE 3000
 
-# Command to run the Next.js project
 CMD ["npm", "run", "dev"]

docker-compose.yml

@@ -1,14 +1,19 @@
 version: '3'
-services:
-  postgres:
+services: 
+  db:
+    container_name: db
     image: postgres
+    restart: always
+    environment:
+      POSTGRES_PASSWORD: password123
+      POSTGRES_USER: user123
+      POSTGRES_DB: db123  
+
     ports:
       - "5432:5432"
-    environment:
-      POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres
-      POSTGRES_DB: ecosync
-  
+    volumes: 
+      - pgdata:/var/lib/postgresql/data
+
   frontend:
     build:
       context: ./client
@@ -18,17 +23,32 @@ services:
       - "3000:3000"
     # volumes:
     #   - ./client:/usr/src/app
-    env_file:
-      - .env
+    environment:
+      - NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=AIzaSyD1HUzeHWo0hXLXknwRgZ_h8bwRIU-_OyU
+      - NEXT_PUBLIC_RECAPTCHA_SITE_KEY=6Lcb-aYpAAAAADJLVict1FyCiey132R8qdWLon2w
+      - RECAPTCHA_SECRET_KEY=6Lcb-aYpAAAAAL7hCRtE4OVhqDA6Qs15Lo8HUHx-
 
   backend:
+    container_name: backend
+    image: backend
     build:
       context: ./server
       dockerfile: Dockerfile
     ports:
       - "8585:8585"
+
+    depends_on:
+      - db
+
     # volumes:
     #   - ./server:/usr/src/app
-    env_file:
-      - .env
+    environment:
+      - PORT=8585
+      - DATABASE_URL=postgresql://user123:password123@db:5432/db123?schema=public
+      - JWT_SECRET=viugh@#%48rsdsdbov087qh798yh
+      - MAIL_EMAIL=sohojthikadari@gmail.com
+      - MAIL_PASSWORD=nlvobxoajkaicdhx
+      - NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=AIzaSyD1HUzeHWo0hXLXknwRgZ_h8bwRIU-_OyU
 
+volumes:
+  pgdata: {}

server/Dockerfile

@@ -1,15 +1,15 @@
-
 FROM node:latest
 
-WORKDIR /usr/src/app
+WORKDIR /app
 
 COPY package*.json ./
 
-RUN apt-get update && apt-get install -y postgresql-client
+RUN npm install
 
 COPY . .
 
+RUN cd ./src && npx prisma generate
+
 EXPOSE 8585
 
-CMD ["sh", "-c", "until pg_isready -h postgres -p 5432; do sleep 1; done && npm i && npm run dev"]
-# CMD ["npx", "nodemon"]
+CMD ["npm", "run", "dev"]

server/package.json

@@ -4,7 +4,6 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "install": "cd ./src && npx prisma migrate dev --name init && createdb ecosync 2> /dev/null || echo \"database already exists\"",
     "build": "tsc",
     "start": "node build/index.js",
     "dev": "ts-node src/index.ts",