dockerised

Author: vsreddyh

.dockerignore

@@ -0,0 +1,6 @@
+backend/.env
+backend/node_modules
+backend/build
+backend/vercel.json
+frontend/.env
+frontend/node_modules

.gitignore

@@ -1 +1,3 @@
-/.dependencygraph
+/.dependencygraph
+.env.development
+.env.production

README.md

@@ -77,31 +77,37 @@ Schedio provides a platform for students/employees, colleges/organizations, and
 ## Features
 
 ### General Features
-1. User Authentication with email (forgot password support)  
-2. Comprehensive skill dataset  
-3. Plagiarism check using RapidAPI  
-4. Upload support for videos, code files, and images  
-5. Tree-like code structure viewer  
-6. Code explanation powered by Gemini  
+
+1. User Authentication with email (forgot password support)
+2. Comprehensive skill dataset
+3. Plagiarism check using RapidAPI
+4. Upload support for videos, code files, and images
+5. Tree-like code structure viewer
+6. Code explanation powered by Gemini
 7. Session persistence for seamless user experience
+
 ###### Note:- T stands for Type
+
 ### T1 User Features (Student/Employee)
-1. View all projects  
-2. Search projects by programming language  
+
+1. View all projects
+2. Search projects by programming language
 3. Tokenized search across projects
-4. Comment/Like functionality on projects  
+4. Comment/Like functionality on projects
 5. Can be added as contributors by T2 users on project uploads.
 6. Add/Edit profile picture and custom Student Description
 7. Auto generates Description on Signing up
 
 ### T2 User Features (College/ Organisation)
+
 1. View only their T1 users' projects.
 2. Monthly Analytics.
 3. Upload projects for T1 users.
 4. Auto-sync skills and projects with T1 profiles.
 5. View and download T1 user profiles as PDFs.
 
 ### T3 User Features (Recruiter)
+
 1. Access to all projects.
 2. Comment on any project.
 3. Filter by Institute or Domain.
@@ -117,6 +123,7 @@ Schedio provides a platform for students/employees, colleges/organizations, and
 To run the project locally, follow these steps.
 
 ### Prerequisites
+
 - Node.js & npm
 - MongoDB Database
 - Git
@@ -126,17 +133,20 @@ To run the project locally, follow these steps.
 ### Installation
 
 1. Clone the repository:
+
    ```sh
    git clone https://github.com/vsreddyh/schedio.git
    ```
 
 2. Install dependencies:
+
    ```sh
    cd frontend && npm install
    cd ../backend && npm install
    ```
 
 3. Create a `.env` file in the `./backend` folder with the following structure:
+
    ```env
    [email protected]
    PASSWORD=your-app-password
@@ -152,6 +162,66 @@ To run the project locally, follow these steps.
    npm run build && node index.js
    ```
 
+### Installation using Docker
+
+1. Clone the repository:
+   ```sh
+   git clone https://github.com/vsreddyh/schedio.git
+   ```
+
+#### For Development
+
+2. Create a `.env.development` file in the root folder with the following structure:
+
+   ```env
+   [email protected]
+   PASSWORD=your-app-password
+   JWT_SECRET=random-32-characters
+   SESSION_KEY=random-32-characters
+   plagarismapi=your-rapidapi-key
+   geminiapi=your-gemini-api-key
+   url=mongodb://your-connection-url/database-name?retryWrites=true&w=majority
+   FRONTEND_URL=http://localhost:3000
+   REACT_APP_BACKEND_URL=http://localhost:3001
+   ```
+
+3. Build the image:
+
+   ```sh
+   docker build -f development.Dockerfile -t app-dev .
+   ```
+
+4. Run the container:
+   ```sh
+   docker run --env-file .env.development -p 3000:3000 -p 3001:3001 app-dev
+   ```
+
+#### For Production
+
+2. Create a `.env.production` file in the root folder with the following structure:
+
+   ```env
+   [email protected]
+   PASSWORD=your-app-password
+   JWT_SECRET=random-32-characters
+   SESSION_KEY=random-32-characters
+   plagarismapi=your-rapidapi-key
+   geminiapi=your-gemini-api-key
+   url=mongodb://your-connection-url/database-name?retryWrites=true&w=majority
+   FRONTEND_URL=website-url
+   ```
+
+3. Build the image:
+
+   ```sh
+   docker build -f production.Dockerfile --build-arg REACT_APP_BACKEND_URL="website-url" -t app-prod .
+   ```
+
+4. Run the container:
+   ```sh
+   docker run --env-file .env.production -p 3001:3001 app-prod
+   ```
+
 ---
 
 ## Contributing
@@ -165,16 +235,19 @@ We welcome contributions of all kinds! Whether it's bug reports, feature suggest
 
 2. **Clone the Repository**
    Clone your forked repository locally to make changes:
+
    ```sh
    git clone https://github.com/your-username/schedio.git
    cd schedio
    ```
 
 3. **Create a New Branch**
    Use meaningful branch names to reflect the type of changes you are making:
+
    ```sh
    git checkout -b feature/your-feature-name
    ```
+
    _Example:_  
    `feature/user-authentication` or `feature/fix-login-issue`
 
@@ -183,12 +256,14 @@ We welcome contributions of all kinds! Whether it's bug reports, feature suggest
 
 5. **Commit Your Changes**
    Write clear, concise commit messages to describe the changes you made:
+
    ```sh
    git commit -m "clear and concise commit name"
    ```
 
 6. **Push Your Branch to GitHub**
    Push the branch to your forked repository:
+
    ```sh
    git push origin feature/your-feature-name
    ```
@@ -213,10 +288,12 @@ We welcome contributions of all kinds! Whether it's bug reports, feature suggest
 ### Reporting Issues and Suggesting Features
 
 If you encounter bugs or have ideas for new features, please open an issue:
-- **Report Bugs**: [Create a Bug Report](https://github.com/vsreddyh/schedio/issues/new?labels=bug)  
-- **Request Features**: [Suggest a Feature](https://github.com/vsreddyh/schedio/issues/new?labels=enhancement)  
+
+- **Report Bugs**: [Create a Bug Report](https://github.com/vsreddyh/schedio/issues/new?labels=bug)
+- **Request Features**: [Suggest a Feature](https://github.com/vsreddyh/schedio/issues/new?labels=enhancement)
 
 Make sure to:
+
 - Provide as much detail as possible.
 - Include steps to reproduce bugs, if applicable.
 
@@ -245,16 +322,17 @@ Your effort makes a huge difference! Every bug report, feature request, and pull
 ![](https://github.com/vsreddyh/schedio/blob/main/frontend/public/Status.png?raw=true)<p style="text-align: center;">Log out option in T1 users</p>
 
 ![](https://github.com/vsreddyh/schedio/blob/main/frontend/public/college.png?raw=true)
-<p style="text-align: center;">Organization HomePage</p>
 
+<p style="text-align: center;">Organization HomePage</p>
 
 ![](https://github.com/vsreddyh/schedio/blob/main/frontend/public/student_profile.png?raw=true)<p style="text-align: center;">Student Page viewed by T3,T2 users</p>
 
 ![](https://github.com/vsreddyh/schedio/blob/main/frontend/public/college_search.png?raw=true)
-<p style="text-align: center;">Filtering by college in Recruiter page</p>
 
+<p style="text-align: center;">Filtering by college in Recruiter page</p>
 
 ![](https://github.com/vsreddyh/schedio/blob/main/frontend/public/Bookmark.png?raw=true)
+
 <p style="text-align: center;">Bookmarks in recruiter page</p>
 
 ---

backend/.dockerignore

@@ -7,17 +7,21 @@ const session = require("express-session");
 const bodyParser = require("body-parser");
 const approute = require("./route.js");
 var MongoDBStore = require("connect-mongodb-session")(session);
-const port = process.env.PORT || 3001;
+const port = process.env.BACKEND_PORT || 3001;
 
 const { SESSION_KEY, url, FRONTEND_URL } = require("./settings/env.js");
 app.use(
   cors({
-    origin: process.env.NODE_ENV === 'production' ? 'https://schedio-coral.vercel.app' : 'http://localhost:3000',
+    origin:
+      process.env.NODE_ENV === "production"
+        ? FRONTEND_URL
+        : "http://localhost:3000",
     credentials: true,
   }),
 );
-
-app.use(express.static(path.join(__dirname, './build')));
+if (process.env.NODE_ENV === "production") {
+  app.use(express.static(path.join(__dirname, "./build")));
+}
 
 app.use(bodyParser.json({ limit: "50mb" })); //limit limits the data which can be uploaded to server.js from frontend
 const store = new MongoDBStore({
@@ -35,18 +39,19 @@ app.use(
     store: store,
     cookie: {
       maxAge: 6 * 60 * 60 * 1000, //6 hours
-      sameSite: process.env.NODE_ENV === 'production'?"strict":"lax",
-      secure: process.env.NODE_ENV === 'production',
+      sameSite: process.env.NODE_ENV === "production" ? "strict" : "lax",
+      secure: process.env.NODE_ENV === "production",
       httpOnly: true,
       rolling: true,
     },
   }),
 );
 
-app.get('/', cors(), (req, res) => {
-  res.sendFile(path.join(__dirname, './build', 'index.html'));
-})
-
+app.get("/", cors(), (req, res) => {
+  if (process.env.NODE_ENV === "production") {
+    res.sendFile(path.join(__dirname, "./build", "index.html"));
+  }
+});
 
 app.use("/en", approute); //routing to all functions
 
@@ -61,8 +66,8 @@ app.get("/checksessionexpiry", async (req, res) => {
 });
 
 app.get("*", function (req, res) {
-  if(process.env.NODE_ENV){
-    res.sendFile(path.resolve(__dirname, './build', 'index.html'));
+  if (process.env.NODE_ENV) {
+    res.sendFile(path.resolve(__dirname, "./build", "index.html"));
   } else {
     console.log(req.path);
     res.status(404).send("This route does not exist");
@@ -72,6 +77,6 @@ app.get("*", function (req, res) {
 app.listen(port, function (req, res) {
   console.log(
     "server is running on Production:-",
-    process.env.NODE_ENV ? "false" : "true",
+    process.env.NODE_ENV == "production" ? "false" : "true",
   );
 });

backend/index.js

@@ -0,0 +1,49 @@
+# dev.Dockerfile
+FROM node:18
+
+WORKDIR /app
+
+# Install a helper to run both processes
+RUN npm install -g concurrently
+
+# Install backend deps
+COPY backend/package*.json ./backend/
+RUN cd backend && npm install
+
+# Install frontend deps
+COPY frontend/package*.json ./frontend/
+RUN cd frontend && npm install
+
+# Copy sources
+COPY backend ./backend
+COPY frontend ./frontend
+
+# Ensure servers bind to all interfaces in containers
+ENV HOST=0.0.0.0
+ENV PORT=3000
+ENV BACKEND_PORT=3001
+
+# Accept secrets at runtime (populated via --env-file .env.development)
+ENV NODE_ENV=development
+ENV url=""
+ENV geminiapi=""
+ENV plagarismapi=""
+ENV SESSION_KEY=""
+ENV JWT_SECRET=""
+ENV PASSWORD=""
+ENV EMAIL=""
+ENV FRONTEND_URL=""
+ENV BUILD_PATH="../backend/build"
+# For React dev, this variable must be available to the dev server process
+ENV REACT_APP_BACKEND_URL="http://localhost:3001"
+
+# Expose dev ports
+EXPOSE 3000 3001
+
+# Forward backend env into the backend process; React dev server will read process.env at start
+# Your backend should read from process.env.* and your frontend dev server can reference
+# import.meta.env.* (Vite) or process.env.REACT_APP_* (CRA) as usual.
+CMD ["concurrently", \
+  "npm:start --prefix backend", \
+  "npm:start --prefix frontend"]
+