Deduplicate and prune project root and docs/ directory

- Consolidate setup documentation: merge COMPLETE_SETUP_INSTRUCTIONS into QUICK_START
- Consolidate status docs: merge SETUP_PROGRESS, SETUP_COMPLETE, COMPLETION_STATUS into STATUS
- Consolidate review docs: merge REVIEW_SUMMARY into PROJECT_REVIEW
- Archive 7 redundant files to docs/archive/
- Update DOCUMENTATION_INDEX.md and README.md references
- Create archive README explaining consolidation
- Reduce root documentation from 19 to 13 files (32% reduction)
- Eliminate ~400 lines of duplicate content
This commit is contained in:
defiQUG
2025-12-03 22:59:57 -08:00
parent a42b987ad9
commit e227931583
13 changed files with 284 additions and 48 deletions

View File

@@ -20,18 +20,33 @@ cd asle
git submodule update --init --recursive
```
## Step 2: Start Infrastructure
## Step 2: Configure Database
Choose one method to set up PostgreSQL:
### Option A: Docker (Recommended)
```bash
# Start PostgreSQL and Redis (if using Docker)
docker-compose up -d postgres redis
# Start PostgreSQL container
docker-compose up -d postgres
# Update backend/.env
DATABASE_URL="postgresql://asle:asle_password@localhost:5432/asle?schema=public"
```
Or install PostgreSQL locally and create a database:
### Option B: Local PostgreSQL
```bash
createdb asle
# Create database (requires PostgreSQL admin access)
sudo -u postgres psql -c "CREATE DATABASE asle;"
# Or: createdb asle
# Update backend/.env with your connection string
DATABASE_URL="postgresql://your_user:your_password@localhost:5432/asle?schema=public"
```
See [DATABASE_SETUP.md](./DATABASE_SETUP.md) for detailed database configuration options.
## Step 3: Backend Setup
```bash
@@ -40,15 +55,9 @@ cd backend
# Install dependencies
npm install
# Copy environment file
# Copy and configure environment
cp .env.example .env
# Edit .env with your configuration
# Minimum required:
# - DATABASE_URL
# - JWT_SECRET
# - RPC_URL
# - DIAMOND_ADDRESS (after deploying contracts)
# Edit .env with your configuration (see DATABASE_SETUP.md)
# Generate Prisma client
npm run prisma:generate
@@ -76,14 +85,9 @@ cd ../frontend
# Install dependencies
npm install
# Copy environment file
# Copy and configure environment
cp .env.example .env.local
# Edit .env.local with your configuration
# Minimum required:
# - NEXT_PUBLIC_API_URL
# - NEXT_PUBLIC_DIAMOND_ADDRESS
# - NEXT_PUBLIC_RPC_URL
# Start frontend (development)
npm run dev