diff --git a/development/backend/index.mdx b/development/backend/index.mdx index efa4175..3de41f1 100644 --- a/development/backend/index.mdx +++ b/development/backend/index.mdx @@ -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`. + + +On first run, visit `http://localhost:5173/setup` (frontend) to initialize the database and create your admin account. + ## Development Guides diff --git a/development/index.mdx b/development/index.mdx index a67af86..f7395fa 100644 --- a/development/index.mdx +++ b/development/index.mdx @@ -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 -``` + + + ```bash + git clone https://github.com/deploystackio/deploystack.git + cd deploystack + ``` + + + + ```bash + cd services/backend + npm install + npm run postgres:local + ``` + + This starts PostgreSQL 18 in Docker with default credentials (`deploystack`/`deploystack`). + + + + ```bash + cp .env.example .env + npm run dev + ``` + + Backend runs at http://localhost:3000 + + + + Open http://localhost:5173/setup in your browser to: + - Initialize the database + - Create your admin account + - Configure basic settings + + + + ```bash + cd services/frontend + npm install + npm run dev + ``` + + Frontend runs at http://localhost:5173 + + + + ```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 + + + To get a registration token, go to Admin → Satellites → Pairing in the DeployStack UI after completing the setup wizard. + + + ## Development Workflow diff --git a/self-hosted/quick-start.mdx b/self-hosted/quick-start.mdx index d618651..928e97c 100644 --- a/self-hosted/quick-start.mdx +++ b/self-hosted/quick-start.mdx @@ -52,7 +52,7 @@ The fastest way to get DeployStack backend and frontend running with proper netw 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 @@ -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 --- diff --git a/self-hosted/setup.mdx b/self-hosted/setup.mdx index 2bfc1f3..1012bbf 100644 --- a/self-hosted/setup.mdx +++ b/self-hosted/setup.mdx @@ -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).