Update project documentation and scripts for improved setup and bilingual support

- Enhanced `README.md` with a quick start guide and detailed project structure.
- Updated `SETUP_GUIDE.md` by removing it as it was redundant.
- Improved `local-development.md` and `development.md` with clearer instructions for database migrations.
- Added bilingual comments in various scripts for better understanding and usability.
- Updated `.gitignore` to include specific build scripts while ignoring others.
- Enhanced `scripts` for database management, including backup and seeding functionalities with bilingual support.
This commit is contained in:
Ho Ngoc Hai
2025-12-27 10:12:46 +07:00
parent 79866e22cf
commit 29c40ea681
23 changed files with 528 additions and 392 deletions

View File

@@ -71,13 +71,14 @@ pnpm format
## Database Migrations
## Database Migrations
```bash
# Create migration
cd services/auth-service
pnpm prisma migrate dev --name add_new_field
# Create migration (dev)
./scripts/db/migrate.sh auth-service dev
# Apply migrations (production)
pnpm prisma migrate deploy
./scripts/db/migrate.sh auth-service deploy
```
## Debugging

View File

@@ -10,7 +10,22 @@ Comprehensive guide for running and developing the project locally with real-tim
- **Git**: For cloning repository
- **Neon Account**: https://neon.tech (for database)
## Initial Setup
## Quick Start (Recommended)
1. **Clone Repository**:
```bash
git clone <repository-url>
cd Base
```
2. **Run Initialization Script**:
```bash
./scripts/setup/init-project.sh
```
This script will install dependencies, generate clients, and setup environment files.
## Manual Setup
### 1. Clone Repository

View File

@@ -71,13 +71,14 @@ pnpm format
## Database Migrations
## Database Migrations
```bash
# Tạo migration
cd services/auth-service
pnpm prisma migrate dev --name add_new_field
# Tạo migration (dev)
./scripts/db/migrate.sh auth-service dev
# Áp dụng migrations (production)
pnpm prisma migrate deploy
./scripts/db/migrate.sh auth-service deploy
```
## Debugging

View File

@@ -10,7 +10,22 @@ Hướng dẫn chi tiết cách chạy và phát triển dự án trên máy loc
- **Git**: Để clone repository
- **Tài khoản Neon**: https://neon.tech (cho database)
## Thiết Lập Ban Đầu
## Bắt Đầu Nhanh (Khuyến Nghị)
1. **Clone Repository**:
```bash
git clone <repository-url>
cd Base
```
2. **Chạy Script Khởi Tạo**:
```bash
./scripts/setup/init-project.sh
```
Script này sẽ cài đặt dependencies, tạo clients, và thiết lập các file môi trường.
## Thiết Lập Thủ Công
### 1. Clone Repository