Merge pull request #111 from akshat-OwO/main

deploy to prod

.dockerignore

@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+#pwa
+sw.js
+workbox-*
+swe-worker-*
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

CHANGELOG.md

@@ -1,5 +1,11 @@
 # syllabusx-client
 
+## 4.9.0
+
+### Minor Changes
+
+-   feat [`268fb1`](https://github.com/akshat-OwO/syllabusx-client/commit/268fb11edfd8ce9e6fbc51f32c024e8454b5c429) ai topic summarizer by [`@mohitarora8181`](https://github.com/mohitarora8181)
+
 ## 4.8.1
 
 ### Patch Changes

Dockerfile

@@ -0,0 +1,18 @@
+FROM node:20
+
+# Install pnpm globally
+RUN npm install -g pnpm
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the package.json and pnpm-lock.yaml files
+COPY package.json pnpm-lock.yaml ./
+
+# Install dependencies with pnpm
+RUN pnpm install --frozen-lockfile
+
+COPY . .
+
+# Run the app
+CMD ["pnpm", "run", "dev"]

README.md

@@ -1,3 +1,4 @@
+
 <div align="center"> 
     <a href="https://github.com/akshat-OwO/syllabusx-client">
         <img src="https://github.com/akshat-OwO/syllabusx-client/blob/main/.github/assets/banner.png?raw=true" alt="SyllabusX Banner">
@@ -12,17 +13,19 @@
   </p>
 </div>
 
-# 🧭 Table of contents
+# 🧭 Table of Contents
+
+- [Introduction 🚀](#Introduction)
+- [Usage](#Usage)
+- [Docker Setup for Development](#Docker-Setup-for-Development)
+- [Technologies Used 📫](#Technologies-Used)
+- [Features](#Features)
+- [How to Contribute](#How-to-Contribute)
+- [Maintainers](#Maintainers)
+- [License](#License)
+- [Contributors](#Contributors)
+- [Support](#Support)
 
--   [Introduction🚀](#Introduction)
--   [Usage](#Usage)
--   [Technologies Used📫](#-Technologies-Used)
--   [Features](#Features)
--   [How to Contributie](#Contributing-to-SyllabusX)
--   [Maintainers](#Maintainers)
--   [License](#License)
--   [Contributors](#Contributors)
--   [Support](#Support)
 
 <br>
 
@@ -44,6 +47,34 @@ To access syllabus information for your branch and semester, follow these simple
 
 It's that easy! Enjoy using SyllabusX for all your academic needs.
 
+# Docker Setup for Development
+
+To run this project with Docker  follow these steps:
+
+### Starting the Application
+
+1. **Start Docker Engine**  
+   Ensure that Docker is installed and running on your system.
+
+2. **Copy Environment Variables**  
+   Copy the example environment file to create a local `.env` file:
+   ```bash
+   cp .env.example .env
+   ```
+
+3. **Start Docker Compose with Watch Mode**  
+   Use Docker Compose to start the application in watch mode:
+   ```bash
+   docker compose up --watch
+   ```
+
+### Stopping the Application
+
+To stop the Docker containers, run:
+```bash
+docker compose down
+```
+
 # Technologies-Used 💻
 
 [![NextJS](https://img.shields.io/badge/NextJS-blue?style=for-the-badge)](https://nextjs.org/docs)
@@ -109,7 +140,8 @@ SyllabusX is Licensed under the <a href="./LICENSE">GPL License</a>. Please go t
 # Contributors
 
 <a href="https://github.com/akshat-OwO/syllabusx-client/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=akshat-OwO/syllabusx-client" />
+ <img src="https://contrib.rocks/image?repo=akshat-OwO/syllabusx-client&v=1" />
+
 </a>
 
 Made with [contrib.rocks](https://contrib.rocks).

compose.yml

@@ -0,0 +1,17 @@
+name: SyllabusX
+services:
+  client:
+    build:
+      context: ./
+      dockerfile: Dockerfile  
+    ports:
+      - 3000:3000
+    develop:
+      watch:
+        - path: ./package.json
+          action: rebuild
+        - path: ./package-lock.json
+          action: rebuild
+        - path: ./
+          target: /app
+          action: sync