Feedback

.gitignore

@@ -0,0 +1,34 @@
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo

Dockerfile

@@ -0,0 +1,55 @@
+# Install dependencies only when needed
+FROM node:16 AS deps
+WORKDIR /app
+
+# Install dependencies based on the preferred package manager
+COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
+RUN \
+    if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
+    elif [ -f package-lock.json ]; then npm ci; \
+    elif [ -f pnpm-lock.yaml ]; then yarn global add pnpm && pnpm i --frozen-lockfile; \
+    else echo "Lockfile not found." && exit 1; \
+    fi
+
+
+# Rebuild the source code only when needed
+FROM node:16 AS builder
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+
+# Next.js collects completely anonymous telemetry data about general usage.
+# Learn more here: https://nextjs.org/telemetry
+# Uncomment the following line in case you want to disable telemetry during the build.
+# ENV NEXT_TELEMETRY_DISABLED 1
+
+RUN npm run build
+
+# If using npm comment out above and use below instead
+# RUN npm run build
+
+# Production image, copy all the files and run next
+FROM node:16 AS runner
+WORKDIR /app
+
+ENV NODE_ENV production
+# Uncomment the following line in case you want to disable telemetry during runtime.
+# ENV NEXT_TELEMETRY_DISABLED 1
+
+RUN addgroup --system --gid 1001 nodejs
+RUN adduser --system --uid 1001 nextjs
+
+COPY --from=builder /app/public ./public
+
+# Automatically leverage output traces to reduce image size
+# https://nextjs.org/docs/advanced-features/output-file-tracing
+COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
+COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
+
+USER nextjs
+
+EXPOSE 3000
+
+ENV PORT 3000
+
+CMD ["node", "server.js"]

README.md

@@ -1,14 +1,24 @@
-# CS3219-AY22-23-Project-Skeleton
-
-This is a template repository for CS3219 project.
-
-## User Service
-1. Rename `.env.sample` file to `.env`.
-2. Create a Cloud DB URL using Mongo Atlas.
-3. Enter the DB URL created as `DB_CLOUD_URI` in `.env` file.
-4. Install npm packages using `npm i`.
-5. Run User Service using `npm run dev`.
-
-## Frontend
-1. Install npm packages using `npm i`.
-2. Run Frontend using `npm start`.
+# PeerPrep - G41
+
+## Getting Started
+
+1. Create `.env.local` file in the root directory
+
+2. Add the following lines:
+
+   ```markdown
+   MONGO_URI=mongodb+srv://peerprep:[email protected]/?retryWrites=true&w=majority
+   MONGO_DB=peerprep
+   MONGO_COLLECTION=users
+   MONGO_QN_EASY=question_easy
+   MONGO_QN_MEDIUM=question_medium
+   MONGO_QN_HARD=question_hard
+   NEXTAUTH_SECRET=0jtDHssr83fgtJKroV6DGQ6uD9BXW4+FvPbehI9zUXY=
+   NEXTAUTH_URL=http://localhost:3000
+   ```
+
+3. In the root directory, run `pnpm install` or `npm install` (`pnpm` is the recommended package manager here, if you do not have `pnpm` installed please try to install it, it is way better than `npm`)
+
+4. Run `pnpm dev`
+
+5. Go to `localhost:3000` and see!