Add docker compose file, updaet dockerfile

Author: alphacoder-mp3

.env.example

@@ -1,6 +1,6 @@
 #Add your DB connection string in Database URL
 #To use and access media files, set up cloudinary and add the details in below keys
-DATABASE_URL="postgresql://postgres:mypassword@localhost:5432/postgres"
-CLOUDINARY_CLOUD_NAME=
-CLOUDINARY_API_KEY=
-CLOUDINARY_API_SECRET=
+DATABASE_URL="postgresql://postgres:mypassword@db:5432/postgres"
+CLOUDINARY_CLOUD_NAME=your_cloud_name
+CLOUDINARY_API_KEY=your_api_key
+CLOUDINARY_API_SECRET=your_api_secret

README.md

@@ -5,7 +5,7 @@
 <h3 align="center">ByteNotes</h3>
 
 <p align="center">
-    The open-source Google Keep and Evernote alike software.
+    The open-source notes making application with features like collaboration in real time and much more.
     <br />
     <a href="https://akshayshinde.com"><strong>Learn more »</strong></a>
     <br />
@@ -62,3 +62,16 @@ We love our contributors! Here's how you can contribute:
 - [Open an issue](https://github.com/alphacoder-mp3/ByteNotes/issues) if you believe you've encountered a bug.
 - Follow the [local development guide](https://ByteNotes/docs/local-development) to get your local dev environment set up.
 - Make a [pull request](https://github.com/alphacoder-mp3/ByteNotes/pull) to add new features/make quality-of-life improvements/fix bugs.
+
+### For Local Development (with existing PostgreSQL)
+
+1. Copy `.env.example` to `.env` and update with your local PostgreSQL and Cloudinary credentials.
+2. Update the `DATABASE_URL` in `docker-compose.yml` to use `host.docker.internal` instead of `db`.
+3. Run `docker-compose -f docker/docker-compose.yml up --build`
+
+### For Remote Users or Fresh Setup
+
+1. Copy `.env.example` to `.env` and update with your Cloudinary credentials.
+2. Run `docker-compose -f docker/docker-compose.yml up --build`
+
+The app will be available at http://localhost:3000

docker/Dockerfile

@@ -2,7 +2,6 @@ FROM node:20.12.0-alpine3.19
 
 WORKDIR /app
 
-# Copy package.json and package-lock.json
 COPY package*.json yarn.lock tsconfig.json components.json next.config.mjs postcss.config.mjs tailwind.config.ts ./
 
 COPY prisma ./prisma/
@@ -14,9 +13,6 @@ RUN npx prisma generate
 
 COPY . .
 
-RUN npm run build
-
-
 EXPOSE 3000
 
-CMD ["npm", "start"]
+CMD ["npm", "run", "dev"]

docker/docker-compose.yml

@@ -0,0 +1,37 @@
+version: '3.8'
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile
+    ports:
+      - "3000:3000"
+    environment:
+      - DATABASE_URL=postgresql://postgres:mypassword@db:5432/postgres
+      - CLOUDINARY_CLOUD_NAME=${CLOUDINARY_CLOUD_NAME}
+      - CLOUDINARY_API_KEY=${CLOUDINARY_API_KEY}
+      - CLOUDINARY_API_SECRET=${CLOUDINARY_API_SECRET}
+    volumes:
+      - ..:/app
+      - /app/node_modules
+    depends_on:
+      - db
+    command: sh -c "
+      npx prisma migrate deploy &&
+      npm run dev
+      "
+      
+  db:
+    image: postgres:13
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=mypassword
+      - POSTGRES_DB=postgres
+    ports:
+      - "5433:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data: