|
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 | +[](https://nodejs.org/) |
| 9 | +[](https://www.typescriptlang.org/) |
| 10 | +[](https://pnpm.io/) |
| 11 | +[](https://expressjs.com/) |
| 12 | +[](https://www.prisma.io/) |
| 13 | +[](https://typeorm.io/) |
| 14 | +[](https://www.postgresql.org/) |
| 15 | +[](https://www.passportjs.org/) |
| 16 | +[](https://jwt.io/) |
| 17 | +[](https://developers.google.com/identity/protocols/oauth2) |
| 18 | +[](https://swagger.io/) |
| 19 | +[](https://react.email/) |
| 20 | +[](https://nodemailer.com/) |
| 21 | +[](https://resend.com/) |
| 22 | +[](https://min.io/) |
| 23 | +[](https://supabase.com/) |
| 24 | +[](https://github.com/expressjs/multer) |
| 25 | +[](https://pdf-lib.js.org/) |
| 26 | +[](https://github.com/exceljs/exceljs) |
| 27 | +[](https://biomejs.dev/) |
| 28 | +[](https://eslint.org/) |
| 29 | +[](https://prettier.io/) |
| 30 | +[](https://typicode.github.io/husky/) |
| 31 | +[](https://www.docker.com/) |
| 32 | +[](https://docs.docker.com/compose/) |
| 33 | +[](https://traefik.io/traefik/) |
| 34 | +[](https://containrrr.dev/watchtower/) |
| 35 | +[](https://github.com/features/packages) |
| 36 | +</div> |
| 37 | + |
2 | 38 |
|
3 | 39 | <h3>Stacks</h3> |
4 | 40 | <ul> |
|
9 | 45 | <li>Prisma</li> |
10 | 46 | <li>JWT</li> |
11 | 47 | <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> |
12 | 53 | </ul> |
13 | 54 |
|
14 | 55 |
|
|
50 | 91 |
|
51 | 92 | <h3>Start Dev</h3> |
52 | 93 | <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> |
54 | 95 | </ul> |
55 | 96 |
|
56 | 97 |
|
57 | 98 |
|
58 | 99 | <h3>Start Prod</h3> |
59 | 100 | <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> |
61 | 103 | </ul> |
62 | 104 |
|
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" /> |
65 | 109 |
|
66 | 110 | <h3>API Flow Design (Prototype)</h3> |
67 | 111 | <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 |
109 | 153 |
|
110 | 154 | <h3>Object Storage Server (S3 Complatible)</h3> |
111 | 155 | <ul> |
112 | | - <li>Endpoint : <code>https://s3-storage.comcamp.io</code></li> |
| 156 | + <li>Endpoint : <code>https://storage.comcamp.io</code></li> |
113 | 157 | <li>Console : <code>https://console-storage.comcamp.io</code></li> |
114 | 158 | </ul> |
115 | 159 |
|
116 | 160 | <h3>Cr.</h3> |
117 | | -<p>Made with 🧡 by ComCamp 37 Technic Team</p> |
| 161 | +<p>Made with 🧡 by ComCamp 37 Technical Team</p> |
0 commit comments