Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion development/backend/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,22 @@ The DeployStack backend is a modern, high-performance Node.js application built
```bash
cd services/backend
npm install

# Start PostgreSQL (requires Docker)
npm run postgres:local

# Configure environment
cp .env.example .env

# Start development server
npm run dev
```

The development server starts at `http://localhost:3000` with API documentation at `/documentation`.
The development server starts at `http://localhost:3000`.

<Info>
On first run, visit `http://localhost:5173/setup` (frontend) to initialize the database and create your admin account.
</Info>

## Development Guides

Expand Down
82 changes: 61 additions & 21 deletions development/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,30 +53,70 @@ DeployStack implements an MCP-as-a-Service architecture that eliminates installa
- Node.js 18 or higher
- npm 8 or higher
- Git for version control
- DeployStack account at [cloud.deploystack.io](https://cloud.deploystack.io) (for satellite testing)
- Docker (for local PostgreSQL)

### Quick Setup

```bash
# Clone the repository
git clone https://github.com/deploystackio/deploystack.git
cd deploystack

# Install dependencies for all services
cd services/frontend && npm install
cd ../backend && npm install
cd ../satellite && npm install

# Start development servers (in separate terminals)
# Terminal 1 - Backend
cd services/backend && npm run dev # http://localhost:3000

# Terminal 2 - Frontend
cd services/frontend && npm run dev # http://localhost:5173

# Terminal 3 - Satellite (for local satellite testing)
cd services/satellite && npm run dev # http://localhost:9095
```
<Steps>
<Step title="Clone Repository">
```bash
git clone https://github.com/deploystackio/deploystack.git
cd deploystack
```
</Step>

<Step title="Start PostgreSQL (Terminal 1)">
```bash
cd services/backend
npm install
npm run postgres:local
```

This starts PostgreSQL 18 in Docker with default credentials (`deploystack`/`deploystack`).
</Step>

<Step title="Configure and Start Backend (Terminal 1)">
```bash
cp .env.example .env
npm run dev
```

Backend runs at http://localhost:3000
</Step>

<Step title="Complete Setup Wizard">
Open http://localhost:5173/setup in your browser to:
- Initialize the database
- Create your admin account
- Configure basic settings
</Step>

<Step title="Start Frontend (Terminal 2)">
```bash
cd services/frontend
npm install
npm run dev
```

Frontend runs at http://localhost:5173
</Step>

<Step title="Start Satellite (Terminal 3 - Optional)">
```bash
cd services/satellite
npm install
cp .env.example .env
# Edit .env: add DEPLOYSTACK_REGISTRATION_TOKEN from admin panel
npm run dev
```

Satellite runs at http://localhost:3001

<Info>
To get a registration token, go to Admin → Satellites → Pairing in the DeployStack UI after completing the setup wizard.
</Info>
</Step>
</Steps>

## Development Workflow

Expand Down
8 changes: 4 additions & 4 deletions self-hosted/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The fastest way to get DeployStack backend and frontend running with proper netw

<Step title="Create Admin Account">
When opening the frontend, you will be redirected to `http://localhost:8080/login`
- Go to "Create Account" to set up your admin user ([read more about user types](/roles))
- Go to "Create Account" to set up your admin user ([read more about user types](/general/roles))
- Login with your new admin account
</Step>

Expand Down Expand Up @@ -422,9 +422,9 @@ If you need assistance:
### Learn More

- **[Self-Hosted Documentation](/self-hosted)**: Comprehensive deployment guides
- **[Local Development](/local-setup)**: Set up development environment
- **[Global Settings](/global-settings)**: Configure email, auth, and more
- **[User Roles](/roles)**: Manage team permissions
- **[Local Development](/general/local-setup)**: Set up development environment
- **[Global Settings](/general/global-settings)**: Configure email, auth, and more
- **[User Roles](/general/roles)**: Manage team permissions

---

Expand Down
2 changes: 1 addition & 1 deletion self-hosted/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -406,4 +406,4 @@ tar xzf deploystack-backup-20250108.tar.gz

---

**Next Steps**: After completing platform setup, configure [user roles and permissions](/roles) and set up your first [team workspaces](/teams).
**Next Steps**: After completing platform setup, configure [user roles and permissions](/general/roles) and set up your first [team workspaces](/general/teams).
Loading