- Renamed auth-service to iam-service across various files for consistency. - Updated Dockerfiles, deployment configurations, and documentation to reflect the service name change. - Enhanced testing commands in documentation to point to the new iam-service. - Removed outdated auth-service files and configurations to streamline the project structure. - Improved bilingual documentation for clarity on the new service structure and usage.
1.8 KiB
1.8 KiB
Getting Started
Prerequisites
- Node.js >= 20.0.0
- PNPM >= 8.0.0
- Docker & Docker Compose
- Git
- Neon account (https://neon.tech) - for database
Initial Setup
-
Clone the repository
git clone <repository-url> cd Base -
Setup Neon Database
# Run setup script ./scripts/db/setup-neon.sh # Or manually: # 1. Create Neon project at https://neon.tech # 2. Create branches: main (dev), staging, production # 3. Get connection strings # 4. Update deployments/local/.env.localSee Neon Setup Guide for details.
-
Initialize the project
./scripts/setup/init-project.sh -
Start infrastructure (Redis, Traefik - no PostgreSQL needed)
cd deployments/local docker-compose up -d cd ../.. -
Run database migrations
./scripts/db/migrate.sh iam-service dev -
Seed the database
./scripts/db/seed.sh iam-service -
Start all services
./scripts/dev/start-all.sh
Access Points
- API Gateway: http://localhost/api/v1
- Auth Service: http://localhost:5001
- Web Admin: http://admin.localhost or http://localhost:3000
- Web Client: http://localhost or http://localhost:3001
- Traefik Dashboard: http://localhost:8080
Database
This project uses Neon PostgreSQL for all environments:
- Development: Neon main branch
- Staging: Neon staging branch
- Production: Neon production branch
No local PostgreSQL needed! See Neon Setup for details.
Next Steps
- Read Development Guide
- Check API Documentation
- Review Architecture Overview