Skip to content

Commit 94c884f

Browse files
committed
docs: update readme docs
1 parent ceb7c45 commit 94c884f

3 files changed

Lines changed: 51 additions & 7 deletions

File tree

README.md

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,40 @@
1-
<h1>ComCamp 37 - Backend</h1>
1+
<div align="center">
2+
<img src="./docs/Comcamp-Logo.png" alt="ComCamp 37 Logo" width="200"/>
3+
4+
<h1> 🐰 ComCamp 37 - Backend 🦊</h1>
5+
6+
**The official RESTful API for the ComCamp 37 registration website.**
7+
8+
[![Node.js](https://img.shields.io/badge/Node.js-22-339933?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/)
9+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
10+
[![pnpm](https://img.shields.io/badge/pnpm-F69220?style=for-the-badge&logo=pnpm&logoColor=white)](https://pnpm.io/)
11+
[![Express.js](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white)](https://expressjs.com/)
12+
[![Prisma](https://img.shields.io/badge/Prisma-2D3748?style=for-the-badge&logo=prisma&logoColor=white)](https://www.prisma.io/)
13+
[![TypeORM](https://img.shields.io/badge/TypeORM-FE0902?style=for-the-badge)](https://typeorm.io/)
14+
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-4169E1?style=for-the-badge&logo=postgresql&logoColor=white)](https://www.postgresql.org/)
15+
[![Passport](https://img.shields.io/badge/Passport-34E27A?style=for-the-badge&logo=passport&logoColor=black)](https://www.passportjs.org/)
16+
[![JWT](https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=jsonwebtokens&logoColor=white)](https://jwt.io/)
17+
[![Google OAuth](https://img.shields.io/badge/Google_OAuth-4285F4?style=for-the-badge&logo=google&logoColor=white)](https://developers.google.com/identity/protocols/oauth2)
18+
[![Swagger](https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=swagger&logoColor=black)](https://swagger.io/)
19+
[![React Email](https://img.shields.io/badge/React_Email-000000?style=for-the-badge&logo=react&logoColor=61DAFB)](https://react.email/)
20+
[![Nodemailer](https://img.shields.io/badge/Nodemailer-30B980?style=for-the-badge)](https://nodemailer.com/)
21+
[![Resend](https://img.shields.io/badge/Resend-000000?style=for-the-badge)](https://resend.com/)
22+
[![MinIO](https://img.shields.io/badge/MinIO-C72E49?style=for-the-badge&logo=minio&logoColor=white)](https://min.io/)
23+
[![Supabase](https://img.shields.io/badge/Supabase-3ECF8E?style=for-the-badge&logo=supabase&logoColor=white)](https://supabase.com/)
24+
[![Multer](https://img.shields.io/badge/Multer-FF6F00?style=for-the-badge)](https://github.com/expressjs/multer)
25+
[![pdf-lib](https://img.shields.io/badge/pdf--lib-DC2626?style=for-the-badge)](https://pdf-lib.js.org/)
26+
[![ExcelJS](https://img.shields.io/badge/ExcelJS-217346?style=for-the-badge)](https://github.com/exceljs/exceljs)
27+
[![Biome](https://img.shields.io/badge/Biome-60A5FA?style=for-the-badge)](https://biomejs.dev/)
28+
[![ESLint](https://img.shields.io/badge/ESLint-4B32C3?style=for-the-badge&logo=eslint&logoColor=white)](https://eslint.org/)
29+
[![Prettier](https://img.shields.io/badge/Prettier-F7B93E?style=for-the-badge&logo=prettier&logoColor=black)](https://prettier.io/)
30+
[![Husky](https://img.shields.io/badge/Husky-000000?style=for-the-badge)](https://typicode.github.io/husky/)
31+
[![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com/)
32+
[![Docker Compose](https://img.shields.io/badge/Docker_Compose-2496ED?style=for-the-badge&logo=docker&logoColor=white)](https://docs.docker.com/compose/)
33+
[![Traefik](https://img.shields.io/badge/Traefik-24A1C1?style=for-the-badge&logo=traefikproxy&logoColor=white)](https://traefik.io/traefik/)
34+
[![Watchtower](https://img.shields.io/badge/Watchtower-4169E1?style=for-the-badge)](https://containrrr.dev/watchtower/)
35+
[![GitHub Container Registry](https://img.shields.io/badge/GHCR-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/features/packages)
36+
</div>
37+
238

339
<h3>Stacks</h3>
440
<ul>
@@ -9,6 +45,11 @@
945
<li>Prisma</li>
1046
<li>JWT</li>
1147
<li>Docker</li>
48+
<li>Swagger</li>
49+
<li>Scalar</li>
50+
<li>Better Auth</li>
51+
<li>MinIO (S3 Compatible Object Storage)</li>
52+
<li>GitHub Container Registry (GHCR)</li>
1253
</ul>
1354

1455

@@ -50,18 +91,21 @@
5091

5192
<h3>Start Dev</h3>
5293
<ul>
53-
<li>Run Dev Server : <code>pnpm run start:dev</code></li>
94+
<li>Run Dev Server : <code>pnpm exec dotenv -e .env.prod -- pnpm run start:dev</code></li>
5495
</ul>
5596

5697

5798

5899
<h3>Start Prod</h3>
59100
<ul>
60-
<li>Run Prod Project on docker (recommended) : <code>docker compose up --build -d</code></li>
101+
<li>Run Prod Project on docker (Build from source) : <code>docker compose up --build -d</code></li>
102+
<li>Run Prod Project on docker (Pull from GHCR + Scale (Recommended)) : <code>docker compose -f docker-compose.prod.yml --env-file .env.prod up -d --scale client=3</code></li>
61103
</ul>
62104

63-
<h3>DB-Diagram (Prototype)</h3>
64-
<iframe width="500" height="315" src='https://dbdiagram.io/e/69ae7fb9cf54053b6f3980fa/69ae7fffcf54053b6f398582'> </iframe>
105+
<h3>DB-Diagram (Final)</h3>
106+
<a href="https://dbdiagram.io/e/69ae7fb9cf54053b6f3980fa/69ae7fffcf54053b6f398582">Open on DB Diagram</a> <br/>
107+
<a href="https://dbdiagram.io/e/69ae7fb9cf54053b6f3980fa/69ae7fffcf54053b6f398582" target="_blank">
108+
<img src="./docs/CC37-V3.png" alt="DB Diagram" />
65109

66110
<h3>API Flow Design (Prototype)</h3>
67111
<a href="https://www.figma.com/board/ZO9E1iaCZasX5wwyK0D6g9/CC37-Backend-Routing-Flow?node-id=0-1&t=meCqyS4DR1seJfqG-1"><p>Open on Figma</p></a>
@@ -109,9 +153,9 @@ BETTER_AUTH_BASE_PATH=http://localhost:3030/api/auth
109153
110154
<h3>Object Storage Server (S3 Complatible)</h3>
111155
<ul>
112-
<li>Endpoint : <code>https://s3-storage.comcamp.io</code></li>
156+
<li>Endpoint : <code>https://storage.comcamp.io</code></li>
113157
<li>Console : <code>https://console-storage.comcamp.io</code></li>
114158
</ul>
115159
116160
<h3>Cr.</h3>
117-
<p>Made with 🧡 by ComCamp 37 Technic Team</p>
161+
<p>Made with 🧡 by ComCamp 37 Technical Team</p>

docs/CC37-V3.png

764 KB
Loading

docs/Comcamp-Logo.png

154 KB
Loading

0 commit comments

Comments
 (0)