Merge pull request #2 from InternComp/hs-integrate-backend

For MVP

Author: harnoor-singh

.gitmodules

@@ -6,10 +6,6 @@
 	path = interncomp-backend
 	url = https://github.com/InternComp/interncomp-backend.git
 	branch = main
-[submodule "interncomp-database"]
-	path = interncomp-database
-	url = https://github.com/InternComp/interncomp-database.git
-	branch = main
 [submodule "interncomp-documentation"]
 	path = interncomp-documentation
 	url = https://github.com/InternComp/interncomp-documentation.git

README.md

@@ -2,16 +2,28 @@
 
 A parent repo for interncomp project
 
-# Initial Setup (To be tested yet)
+# Initial Setup 
 
-Use following to clone:
+## Cloning the project
+
+Use following command to clone:
 
 ```
 git clone --recurse-submodules https://github.com/InternComp/interncomp-platform.git
 ```
 
-To update all:
+To update all repos:
 
 ```
 git submodule update --remote
 ```
+
+## Setup .env files
+
+Setup .env files as discussed in assignment submission.
+
+## Running the code
+
+See manual-setup.md in this repo.
+
+

docker-compose.dev.yml

@@ -7,39 +7,43 @@ services:
       - ./interncomp-frontend:/app
       - /app/node_modules # Avoid overwriting node_modules
     ports:
-      - '5173:5173' # Vite default port
+      - '4000:4000' # Frontend is being set at port 4000 in vite.config.js
     networks:
       - app-network
 
-  # backend:
-  #   build:
-  #     context: ./interncomp-backend
-  #     dockerfile: Dockerfile.dev
-  #   volumes:
-  #     - ./interncomp-backend:/app
-  #     - /app/node_modules # Avoid overwriting node_modules
-  #   ports:
-  #     - '4000:3000' # Map backend container's port 3000 to local port 4000
-  #   depends_on:
-  #     - db
-  #   environment:
-  #     DATABASE_URL: postgres://postgres:password@db:5432/interncomp-database
-  #   networks:
-  #     - app-network
-
-  db:
+  postgres:
     image: postgres:15-alpine
     environment:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: password
       POSTGRES_DB: interncomp-database
     ports:
-      - '5432' # Map some automatically chosen machine port to container's PostgreSQL port 5432
+      - '5433:5432' # Map some automatically chosen machine port to container's PostgreSQL port 5432
     volumes:
       - pgdata:/var/lib/postgresql/data
     networks:
       - app-network
 
+  backend:
+    build:
+      context: ./interncomp-backend
+      dockerfile: Dockerfile.dev
+    volumes:
+      - ./interncomp-backend:/app
+      - /app/node_modules # Avoid overwriting node_modules
+    ports:
+      - '3000:3000' # Map backend container's port 3000 to local port 3000
+    depends_on:
+      - postgres
+    environment:
+      DATABASE_URL: postgres://postgres:password@postgres:5432/interncomp-database
+    # command: sh -c "npm install && npx prisma migrate dev && npm run seed && "./wait-for-it.sh postgres:5432 -- npm run dev""
+    networks:
+      - app-network
+    # entrypoint: ["/bin/sh", "-c", "./wait-for-it.sh postgres:5432 -- npm run dev"]
+
+
+
 networks:
   app-network:
     driver: bridge

interncomp-backend

@@ -0,0 +1,48 @@
+## Running manually (Deprecated, for archivial purpose only)
+
+### Frontend
+
+**Setup (One Time Only)**
+
+Assuming Node 20 LTS is installed
+
+1. Go to frontend repo in terminal. For eg: `cd interncomp-frontend`.
+2. Do `git pull` just in case.
+3. Run `npm install`
+
+**Running frontend**
+To run, use `npm run dev`
+
+
+### Backend
+
+Firstly, we need to setup database.
+Assuming Postgresql is installed, and make sure service is running.
+
+Run in terminal: `sudo -u postgres psql -U postgres`
+
+Then in postgres:
+```bash
+postgres=# CREATE USER test WITH PASSWORD 'password';
+CREATE ROLE
+postgres=# GRANT ALL PRIVILEGES ON DATABASE "interncomp-database" TO test;
+GRANT
+postgres=# ALTER USER test WITH SUPERUSER;
+ALTER ROLE
+postgres=# exit
+```
+
+Continue with backend setup
+
+**Backend Setup (One Time Only)**
+
+Assuming Node 20 LTS and Postgresql is installed
+
+```bash
+npx prisma generate
+npm install
+npx prisma migrate dev --name init
+```
+
+**Running backend**
+To run, use `npm run dev`