Files
pos-system/docs/en/guides/getting-started.md
Ho Ngoc Hai b104fafa85 Refactor auth-service to iam-service and update related documentation
- 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.
2025-12-30 20:54:21 +07:00

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

  1. Clone the repository

    git clone <repository-url>
    cd Base
    
  2. 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.local
    

    See Neon Setup Guide for details.

  3. Initialize the project

    ./scripts/setup/init-project.sh
    
  4. Start infrastructure (Redis, Traefik - no PostgreSQL needed)

    cd deployments/local
    docker-compose up -d
    cd ../..
    
  5. Run database migrations

    ./scripts/db/migrate.sh iam-service dev
    
  6. Seed the database

    ./scripts/db/seed.sh iam-service
    
  7. Start all services

    ./scripts/dev/start-all.sh
    

Access Points

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