Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.
Merged
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
75 changes: 38 additions & 37 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ Deploy your first application on the Suga platform in just a few steps. The Suga
```

Select a template that matches your use case:
<Tip>
You can make your own templates too.
</Tip>
```bash
Welcome to Suga, this command will help you create a project from a template.
If you already have a project, run suga init instead.
Expand All @@ -38,40 +35,6 @@ Deploy your first application on the Suga platform in just a few steps. The Suga

✓ Project created!
```

Navigate to your project and install dependencies:

```bash title="Navigate to Project" icon="folder"
cd my-first-app
```

<Tabs>
<Tab title="Node.js">
```bash title="Install Dependencies" icon="package"
npm install
```
</Tab>
<Tab title="Python">
```bash title="Install Dependencies (uv)" icon="package"
uv sync
```

Or with pip:
```bash title="Install Dependencies (pip)" icon="package"
pip install -r requirements.txt
```
</Tab>
<Tab title="Go">
```bash title="Install Dependencies" icon="package"
go mod tidy
```
</Tab>
</Tabs>

<Info>
Your project structure will include `suga.yaml` for configuration, service code, and language-specific dependencies.
</Info>

</Step>

<Step title="Design Your Architecture" icon="pen-to-square">
Expand Down Expand Up @@ -148,6 +111,44 @@ Deploy your first application on the Suga platform in just a few steps. The Suga
</Step>

<Step title="Develop Locally" icon="code">

Navigate to your project and install dependencies:

```bash title="Navigate to Project" icon="folder"
cd my-first-app
```

<Tabs>
<Tab title="Node.js">
```bash title="Install Dependencies (node)" icon="cube"
suga generate --ts --ts-out ./suga/client
npm install
```
</Tab>
<Tab title="Python">
```bash title="Install Dependencies (uv)" icon="cube"
suga generate --python --python-out ./suga_gen
uv sync
```

Or with pip:
```bash title="Install Dependencies (pip)" icon="cube"
suga generate --python --python-out ./suga_gen
pip install -r requirements.txt
```
</Tab>
<Tab title="Go">
```bash title="Install Dependencies (go)" icon="cube"
suga generate --go --go-out ./suga --go-package-name suga
go mod tidy
```
</Tab>
</Tabs>

<Info>
Your project structure will include `suga.yaml` for configuration, service code, and language-specific dependencies.
</Info>

Start the development server:

```bash title="Start Development Server" icon="play"
Expand Down