Getting Started
Get up and running with StackForDevs in minutes. This guide covers everything you need to start building with our backend services.
Your API Credentials
Use these credentials to authenticate your requests to StackForDevs services. You can find your actual credentials in the Admin Dashboard.
Interactive API Documentation
Test API endpoints directly in your browser with our interactive Swagger UI. Perfect for exploring the API, testing requests, and understanding response formats.
Development Workflow with AI Assistance
This guide walks you through the complete workflow for building with StackForDevs using AI-assisted development ("vibe coding"). Follow these steps to set up your environment, extend the Starter App, and iterate quickly.
Set Up Your Local Environment
Install the required tools to run the Starter App locally and work with AI-assisted development.
1. Install Docker Desktop
Docker provides an isolated environment with all dependencies pre-configured.
- macOS/Windows: Download from docker.com/products/docker-desktop
- Linux: Install via package manager or from docs.docker.com/engine/install
# Verify Installation
docker --version
2. Install Git
Git is essential for version control and working with AI coding agents.
- macOS:
brew install gitor download from git-scm.com - Windows: Download from git-scm.com
- Linux:
sudo apt install git(Ubuntu/Debian) or use your package manager
# Verify Installation
git --version
3. Install Node.js and npm
Node.js and npm (Node Package Manager) are required to install AI coding tools like Claude Code.
- macOS:
brew install nodeor download from nodejs.org - Windows: Download from nodejs.org
- Linux:
sudo apt install nodejs npm(Ubuntu/Debian) or use your package manager
# Verify Installation
node --version && npm --version
Choose Your AI Coding Agent
Select an AI coding agent to help you build features faster. We recommend Claude Code for its deep integration with your development workflow.
Recommended: Claude Code
Claude Code is a powerful CLI tool that can read, write, and edit files, run commands, and understand your entire codebase context.
- Full codebase awareness and navigation
- Integrated terminal access and command execution
- Multi-file editing with context preservation
- Understands Docker and can help with container management
# Install Claude Code (requires npm)
npm install -g @anthropic-ai/claude-code
Learn more at code.claude.com
Download the Starter App
Download our pre-configured Next.js starter application with all StackForDevs services integrated and ready to use.
.env file with your live credentials, so you can start building immediately without manual setup.
Alternatively, clone from GitHub if you prefer:
git clone https://github.com/stackfordevs/starter-app.git
cd starter-app
After cloning from GitHub:
- Open the folder in your terminal
- Create a
.envfile with your credentials from the Admin Dashboard - Run the app with Docker:
docker compose up -d --build - Open your browser and visit http://localhost:3000
# .env file example
NEXT_PUBLIC_API_KEY=YOUR_PUBLIC_API_KEY
API_SECRET_KEY=YOUR_SECRET_API_KEY
NEXT_PUBLIC_TENANT_ID=YOUR_TENANT_ID
NEXT_PUBLIC_PROJECT_ID=YOUR_PROJECT_ID
Extend the App with AI Assistance
Now comes the fun part! Use Claude Code to add features, modify existing functionality, and build your application with AI assistance.
Getting Started with Claude Code:
1. Launch Claude Code in your project:
# Open your terminal in the starter app directory
claude
2. Start building with comprehensive prompts:
Provide detailed context and requirements for best results. Here are example prompts that work well:
Example 1:
"I need to add a user profile feature. Create a /profile page that displays
the current user's information from the auth service. Include fields for name,
email, and account creation date. Add an 'Edit Profile' button that opens a
form to update the user's display name. Use the existing design system and
Tailwind styling patterns from the codebase. Make sure to handle loading
states and errors properly."
Example 2:
"Create a blog feature using the CMS service. I need: 1) A /blog page that
lists all blog posts with pagination, 2) A /blog/[slug] page for individual
posts, 3) An admin section at /admin/blog to create and edit posts with a
rich text editor, 4) Integration with the CMS API for CRUD operations. Follow
the existing authentication patterns and ensure only authenticated users can
access the admin section."
Example 3:
"Implement an email notification system for password resets. When a user
requests a password reset: 1) Generate a secure reset token, 2) Use the
mailer service to send an email with a reset link, 3) Create a
/reset-password/[token] page where users can enter a new password, 4) Validate
the token and update the password via the auth service. Include proper error
handling for expired tokens and email delivery failures."
3. Claude Code will:
- Understand your existing codebase and architecture
- Write new components and integrate with StackForDevs APIs
- Update routing, styling, and configuration automatically
- Run commands like npm install or Docker commands when needed
View Best Practices & Advanced Techniques →
Run and Test Your Changes
The Starter App includes Docker configuration for easy local development. Here's how to run and see your changes.
First Time Setup:
docker compose up -d --build
This builds the Docker image and starts the containers in detached mode. The app will be available at http://localhost:3000
Common Commands:
# Start containers (after initial build)
docker compose up -d
# Rebuild after code changes
docker compose up -d --build
# Stop containers
docker compose down
# View logs
docker compose logs -f
# Clean rebuild (removes volumes)
docker compose down -v && docker compose up -d --build
docker compose up -d --build after making changes to see them reflected.
- Ask Claude Code to implement a feature
- Claude writes the code
- Rebuild with
docker compose up -d --build - Check
http://localhost:3000to see changes - Provide feedback and iterate with Claude
- Repeat until perfect!
Services Overview
StackForDevs provides multiple backend services to power your application:
Authentication Service
User registration, login, password reset, email verification, and session management.
View Documentation →Notification Service
In-app notifications, real-time updates, notification history, and management.
View Documentation →Mailer Service
Transactional emails, templating, attachments, and delivery tracking.
View Documentation →LLM Service
AI completions via OpenAI and Anthropic, batch processing, and model selection.
View Documentation →CMS Service
Content management, collections, media storage, and multi-language support.
View Documentation →Billing Service
Stripe integration, subscriptions, invoices, webhooks, and customer portal management.
View Documentation →Service Base URLs
All API requests should be made to these base URLs: