Skip to content

Commit e190d6f

Browse files
committed
fix: updates project setup instructions
Provides clearer instructions for setting up a new project or initializing Suga in an existing project.
1 parent f71f06a commit e190d6f

File tree

1 file changed

+40
-19
lines changed

1 file changed

+40
-19
lines changed

docs/quickstart.mdx

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,49 @@ You'll see a confirmation:
3232

3333
Create a new project from a template:
3434

35-
```bash title="Create New Project" icon="sparkles"
36-
suga new my-first-app
37-
```
35+
Suga can be initialized into an existing project, a new folder, or you can use the new command to scaffold a starter template.
3836

39-
Select any template you prefer:
37+
<Tabs>
38+
<Tab title="Initialize your Project">
39+
Initialize Suga in your project directory:
4040

41-
<Info>
42-
You're welcome to use frameworks or tools beyond what's listed in the Templates, consider them a starting point or example.
43-
</Info>
41+
```bash title="Initialize in Existing Project" icon="folder-plus"
42+
cd your-existing-app
43+
suga init
44+
```
4445

45-
```bash
46-
Welcome to Suga, this command will help you create a project from a template.
47-
If you already have a project, run suga init instead.
46+
This will create a `suga.yaml` file and guide you through configuring your application.
47+
</Tab>
48+
<Tab title="Start from Template">
49+
Create a new project from a template:
4850

49-
Project name: my-first-app
50-
Template:
51-
➜ suga/go-standard
52-
suga/python-django-pip
53-
suga/python-fastapi-uv
54-
suga/typescript-express
51+
```bash title="Create New Project" icon="sparkles"
52+
suga new my-first-app
53+
```
5554

56-
Template: suga/go-standard
55+
Select any template you prefer:
5756

58-
✓ Project created!
59-
```
57+
<Info>
58+
You're welcome to use frameworks or tools beyond what's listed in the Templates, consider them a starting point or example.
59+
</Info>
60+
61+
```bash
62+
Welcome to Suga, this command will help you create a project from a template.
63+
If you already have a project, run suga init instead.
64+
65+
Project name: my-first-app
66+
Template:
67+
➜ suga/go-standard
68+
suga/python-django-pip
69+
suga/python-fastapi-uv
70+
suga/typescript-express
71+
72+
Template: suga/go-standard
73+
74+
✓ Project created!
75+
```
76+
</Tab>
77+
</Tabs>
6078

6179
## Design Your Application
6280

@@ -76,6 +94,9 @@ The editor launches in your browser:
7694
Opening browser to the editor
7795
Use Ctrl-C to exit
7896
```
97+
<Note>
98+
If you initialized with `suga init`, you'll be prompted to select a target platform (e.g., `suga/aws@1` or `suga/gcp@1`) when opening the editor.
99+
</Note>
79100

80101
Use the visual editor to design your APIs, databases, storage, and other cloud resources with drag-and-drop simplicity.
81102

0 commit comments

Comments
 (0)