Skip to main content

Quick Start

Get from zero to a running service with CI/CD and cloud infrastructure in under 30 minutes.

1. Install the CLI

npm install -g @muslito/idp-cli

2. Generate a service scaffold

idp scaffold new --type nodejs --name my-service

The CLI will generate a new directory my-service/ with:

  • Full project structure (routes → controllers → services → repositories)
  • Dockerfile and docker-compose for local dev
  • GitHub Actions CI/CD pipeline
  • .env.example with all required variables

3. Start developing

cd my-service
npm install # or: pip install -r requirements.txt
cp .env.example .env
npm run dev # or: uvicorn app.main:app --reload

Open http://localhost:3000/health to verify.

4. Deploy infrastructure

Choose the blueprint that matches your service's data needs:

# Serverless API + DynamoDB
idp blueprint deploy apigw-lambda-dynamodb \
--name my-service \
--env dev \
--region us-east-1

# Containerised service + PostgreSQL
idp blueprint deploy ecs-fargate-rds \
--name my-service \
--env dev \
--region us-east-1

5. Push and watch CI run

git init
git add .
git commit -m "chore: initial scaffold"
git remote add origin https://github.com/your-org/my-service.git
git push -u origin main

Your GitHub Actions workflow will automatically run lint → test → build → deploy.


What's next?