first commit 🎉

README.md

@@ -0,0 +1,35 @@
+# MBG Back-end
+![Version](https://img.shields.io/badge/Version-1.0.0-green?style=flat-square&logo=gitea&logoColor=white)
+
+A back-end service built by 🌧 Skyrain Studio.
+
+## Features
+Coming soon.
+
+## Requirements
+- Node.js v22.19 and up.
+- NPM v10.9 and up.
+- PostgreSQL v17 and up.
+- S3-compatible object storage (optional, for user session storage).
+- Docker (for Docker deployment).
+
+## Setup
+1. Make sure requirements are met.
+2. Clone project.
+3. Copy `.env.example` into `.env`.
+4. Run `npm install`.
+5. For development, run `npm run dev`.
+6. For production, run `npm run start`.
+
+## Docker Deployment
+1. Make sure requirements are met.
+2. Clone project.
+3. Set the environment variable according to variables defined in `.env`.
+4. Build image and deploy.
+
+## Docker Deployment with Docker Compose
+1. Make sure requirements are met.
+2. Clone project.
+3. Copy `docker-compose.example.yaml` into `docker-compose.yaml`.
+4. Adjust values in `docker-compose.yaml` accordingly.
+5. Deploy with Docker Compose.