Introduce mono repo

.github/workflows/ci_backend.yaml

@@ -1,3 +1,5 @@
+# @format
+
 name: CI Backend
 on:
   push:
@@ -22,20 +24,27 @@ jobs:
     env:
       working-directory: ./backend
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
       - name: Install packages
-        run: npm ci
+        run: pnpm install --frozen-lockfile
+        working-directory: ${{ env.working-directory }}
+      - name: Generate prisma
+        run: pnpm db:generate
         working-directory: ${{ env.working-directory }}
       - name: Prettier
-        run: npm run format:check
+        run: pnpm run format:check
         working-directory: ${{ env.working-directory }}
       - name: Lint
-        run: npm run lint
+        run: pnpm run lint
         working-directory: ${{ env.working-directory }}
       - name: Build
-        run: npm run build
+        run: pnpm run build
         working-directory: ${{ env.working-directory }}

.github/workflows/ci_frontend.yaml

@@ -1,3 +1,5 @@
+# @format
+
 name: CI Frontend
 on:
   push:
@@ -22,20 +24,24 @@ jobs:
     env:
       working-directory: ./frontend
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
       - name: Install packages
-        run: npm ci
+        run: pnpm install --frozen-lockfile
         working-directory: ${{ env.working-directory }}
       - name: Prettier
-        run: npm run format:check
+        run: pnpm run format:check
         working-directory: ${{ env.working-directory }}
       - name: Lint
-        run: npm run lint
+        run: pnpm run lint
         working-directory: ${{ env.working-directory }}
       - name: Build
-        run: npm run build
+        run: pnpm run build
         working-directory: ${{ env.working-directory }}

.github/workflows/gh_pages.yaml

@@ -1,3 +1,5 @@
+# @format
+
 name: GitHub Page Publish
 
 on:
@@ -12,13 +14,14 @@ jobs:
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
-
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Setup Node 🔧
         uses: actions/setup-node@v4
         with:
           node-version: "18"
-          cache: "npm"
-          cache-dependency-path: frontend/package-lock.json
+          cache: "pnpm"
+          cache-dependency-path: pnpm-lock.yaml
 
       - name: Setup Sentry Env 🛠️
         working-directory: ${{ env.working-directory }}
@@ -32,8 +35,8 @@ jobs:
         env:
           NODE_OPTIONS: "--max_old_space_size=4096"
         run: |
-          npm ci
-          npm run build
+          pnpm install --frozen-lockfile
+          pnpm run build
 
       - name: Deploy 🚀
         uses: JamesIves/[email protected]

Dockerfile

@@ -0,0 +1,51 @@
+# Stage 1: build codepair backend
+# Start from the node base image
+FROM node:alpine3.18 AS base
+# Set pnpm installation directory and add it to the PATH
+RUN corepack enable
+RUN corepack use pnpm@9
+
+# Download dependency for Prisma
+RUN apk upgrade --update-cache --available && \
+    apk add openssl && \
+    rm -rf /var/cache/apk/*
+
+# Download dependencies for Puppeteer
+RUN apk add --no-cache \
+    chromium \
+    nss \
+    freetype \
+    harfbuzz \
+    ca-certificates \
+    ttf-freefont
+
+# Download Korean font for Puppeteer
+RUN mkdir /usr/share/fonts/nanumfont && \
+    wget http://cdn.naver.com/naver/NanumFont/fontfiles/NanumFont_TTF_ALL.zip && \
+    unzip NanumFont_TTF_ALL.zip -d /usr/share/fonts/nanumfont && \ 
+    fc-cache -f -v
+
+# Set the environment variables
+ENV NODE_ENV production
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
+ENV PUPPETEER_EXECUTABLE_PATH /usr/bin/chromium-browser
+
+# Stage 2: build stage
+FROM base AS build
+COPY . /usr/src/app
+WORKDIR /usr/src/app
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --frozen-lockfile
+RUN pnpm backend db:generate
+RUN pnpm backend build
+RUN pnpm deploy --filter=backend --prod /prod/backend
+WORKDIR /prod/backend
+RUN pnpx prisma generate
+
+# Stage 3: deploy stage
+FROM base AS backend
+COPY --from=build /prod/backend /prod/backend
+WORKDIR /prod/backend
+EXPOSE 3000
+
+# Run the backend server
+CMD ["pnpm", "run", "start:prod"]

MAINTAINING.md

@@ -1,11 +1,13 @@
+<!-- @format -->
+
 # Maintaining CodePair
 
 ## Releasing a New Version
 
 ### 1. Update the version number.
 
-- Update `version` in [package.json in `frontend/`](https://github.com/yorkie-team/codepair/blob/1f10dff1d9c253f921ba136c812383fbb292078f/frontend/package.json#L5) and [package.json in `backend/`](https://github.com/yorkie-team/codepair/blob/1f10dff1d9c253f921ba136c812383fbb292078f/backend/package.json#L3).
-- Update `version` in `package-lock.json` in `frontend/` and `backend/`. It will be automatically updated when you run `npm install`.
+- Update the `version` field in the root `package.json` file to reflect the overall version of the monorepo.
+- Also, update `version` fields in the [`frontend` package.json](https://github.com/yorkie-team/codepair/blob/1f10dff1d9c253f921ba136c812383fbb292078f/frontend/package.json#L3) and [`backend` package.json](https://github.com/yorkie-team/codepair/blob/1f10dff1d9c253f921ba136c812383fbb292078f/backend/package.json#L3).
 
 ### 2. Write changelog of this version in [CHANGELOG.md](https://github.com/yorkie-team/codepair/blob/main/CHANGELOG.md).
 

README.md

@@ -62,15 +62,19 @@ We offer two options. Choose the one that best suits your needs:
    docker-compose -f ./backend/docker/docker-compose-full.yml up -d
    ```
 
-3. Run the Frontend application:
+3. Install dependencies from the root.
 
    ```bash
-   cd frontend
-   npm install
-   npm run dev
+   pnpm install
    ```
 
-4. Visit http://localhost:5173 to enjoy your CodePair.
+4. Run the Frontend application.
+
+   ```bash
+   pnpm frontend dev
+   ```
+
+5. Visit http://localhost:5173 to enjoy your CodePair.
 
 ### 3-2. Full Stack Development Mode
 
@@ -91,20 +95,17 @@ We offer two options. Choose the one that best suits your needs:
    docker-compose -f ./backend/docker/docker-compose.yml up -d
    ```
 
-3. Run the Backend application:
+3. Install dependencies from the root.
 
    ```bash
-   cd backend
-   npm install
-   npm run start:dev
+   pnpm install
    ```
 
-4. Run the Frontend application:
+4. Run the Backend application and the Frontend application:
 
    ```bash
-   cd ../frontend
-   npm install
-   npm run dev
+   pnpm backend start:dev
+   pnpm frontend dev
    ```
 
 5. Visit http://localhost:5173 to enjoy your CodePair.

backend/README.md

@@ -27,15 +27,20 @@ This project is the backend part of the CodePair service developed using NestJS.
     docker-compose -f ./backend/docker/docker-compose.yml up -d
     ```
 
-4. Run the Backend application:
+4. Install dependencies from the root.
 
     ```bash
-    cd backend
-    npm install
-    npm run start:dev
+    pnpm install
     ```
 
-5. Visit http://localhost:3000 to enjoy your CodePair.
+5. Run the Backend application:
+
+    ```bash
+    # In the root directory of the repository and run.
+    pnpm backend start:dev
+    ```
+
+6. Visit http://localhost:3000 to enjoy your CodePair.
 
 ## API Specification
 
@@ -46,31 +51,31 @@ You can access the Swagger-based REST API specification at `<API_URL>/api` when
 ### Building the Project:
 
 ```bash
-npm run build
+pnpm backend build
 ```
 
 Builds the project.
 
 ### Linting the Code:
 
 ```bash
-npm run lint
+pnpm backend lint
 ```
 
 Lints TypeScript files using ESLint. Fixes any fixable linting errors.
 
 ### Testing:
 
 ```bash
-npm test
+pnpm backend test
 ```
 
 Runs unit tests using Jest.
 
 ### Running in Production:
 
 ```bash
-npm start
+pnpm backend start
 ```
 
 Starts the server in production mode.