Skip to content

Commit ba1e5f3

Browse files
committed
[FIX] fix index.md
1 parent 5290f8c commit ba1e5f3

2 files changed

Lines changed: 59 additions & 35 deletions

File tree

docs/css/termynal.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
max-width: 100%;
1818
background: var(--color-bg);
1919
color: var(--color-text);
20-
font-size: 16px;
20+
font-size: 14px;
2121
font-family: 'Fira Mono', Consolas, Menlo, Monaco, 'Courier New', Courier, monospace;
2222
border-radius: 4px;
2323
padding: 75px 45px 35px;
@@ -53,7 +53,7 @@
5353

5454
[data-ty] {
5555
display: block;
56-
line-height: 2;
56+
line-height: 1.6;
5757
}
5858

5959
[data-ty]:before {

docs/index.md

Lines changed: 57 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,15 @@ Installing dependencies...
101101

102102
---> 100%
103103

104-
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
105-
│ ✨ Dependencies installed successfully
106-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
107-
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
108-
│ ✨ FastAPI project '<your-project-name>' has been created successfully and saved to '<your-project-path>'!
109-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
110-
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
111-
│ ℹ To start your project, run 'fastkit runserver' at newly created FastAPI project directory
112-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
104+
╭───────────────────────────── Success ──────────────────────────────╮
105+
│ ✨ Dependencies installed successfully │
106+
╰────────────────────────────────────────────────────────────────────╯
107+
╭───────────────────────────── Success ──────────────────────────────╮
108+
│ ✨ FastAPI project '<your-project-name>' has been created successfully and saved to '<your-project-path>'! │
109+
╰────────────────────────────────────────────────────────────────────╯
110+
╭─────────────────────────────── Info ───────────────────────────────╮
111+
│ ℹ To start your project, run 'fastkit runserver' at newly created FastAPI project directory │
112+
╰────────────────────────────────────────────────────────────────────╯
113113
```
114114

115115
</div>
@@ -129,12 +129,12 @@ $ fastkit addroute <your-project-name> <new-route-name>
129129

130130
---> 100%
131131

132-
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
133-
│ ℹ Updated main.py to include the API router
134-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
135-
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
136-
│ ✨ Successfully added new route '<new-route-name>' to project '<your-project-name>'.
137-
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
132+
╭─────────────────────────────── Info ───────────────────────────────╮
133+
│ ℹ Updated main.py to include the API router │
134+
╰────────────────────────────────────────────────────────────────────╯
135+
╭───────────────────────────── Success ──────────────────────────────╮
136+
│ ✨ Successfully added new route '<new-route-name>' to project '<your-project-name>'. │
137+
╰────────────────────────────────────────────────────────────────────╯
138138
```
139139

140140
</div>
@@ -151,33 +151,45 @@ Place a structured FastAPI demo project immediately with:
151151

152152
```console
153153
$ fastkit startdemo
154-
Enter the project name: <your-project-name>
155-
Enter the author name: <your-name>
156-
Enter the author email: <your-email>
157-
Enter the project description: <your-project-description>
154+
Enter the project name: my-awesome-demo
155+
Enter the author name: John Doe
156+
Enter the author email: john@example.com
157+
Enter the project description: My awesome FastAPI demo
158158
Deploying FastAPI project using 'fastapi-default' template
159159
Template path:
160-
/<fastapi_fastkit-package-path>/fastapi_project_template/fastapi-defau
161-
lt
160+
/~fastapi_fastkit-package-path~/fastapi_project_template/fastapi-default
161+
162+
163+
Project Information
164+
┌──────────────┬─────────────────────────┐
165+
│ Project Name │ my-awesome-demo │
166+
│ Author │ John Doe │
167+
│ Author Email │ john@example.com │
168+
│ Description │ My awesome FastAPI demo │
169+
└──────────────┴─────────────────────────┘
162170

163171

164-
Project Information
165-
┌──────────────┬──────────────────────────────────────────┐
166-
│ Project Name │ <your-project-name> │
167-
│ Author │ <your-name> │
168-
│ Author Email │ <your-email> │
169-
│ Description │ <your-project-description> │
170-
└──────────────┴──────────────────────────────────────────┘
172+
Template Dependencies
173+
┌──────────────┬───────────────────┐
174+
│ Dependency 1 │ fastapi │
175+
│ Dependency 2 │ uvicorn │
176+
│ Dependency 3 │ pydantic │
177+
│ Dependency 4 │ pydantic-settings │
178+
│ Dependency 5 │ python-dotenv │
179+
└──────────────┴───────────────────┘
171180

172181
Do you want to proceed with project creation? [y/N]: y
173-
FastAPI template project will deploy at '<your-project-path>'
182+
FastAPI template project will deploy at '~your-project-path~'
174183

175184
---> 100%
176185

177-
╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
178-
│ ✨ FastAPI project '<your-project-name>' from 'fastapi-default' has been created and saved to │
179-
│ <your-project-path>! │
180-
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
186+
╭────────────────────────── Success ──────────────────────────╮
187+
│ ✨ Dependencies installed successfully │
188+
╰─────────────────────────────────────────────────────────────╯
189+
╭────────────────────────── Success ──────────────────────────╮
190+
│ ✨ FastAPI project 'my-awesome-demo' from 'fastapi-default' │
191+
│ has been created and saved to ~your-project-path~! │
192+
╰─────────────────────────────────────────────────────────────╯
181193
```
182194

183195
</div>
@@ -188,6 +200,18 @@ To view the list of available FastAPI demos, check with:
188200

189201
```console
190202
$ fastkit list-templates
203+
Available Templates
204+
┌─────────────────────────┬───────────────────────────────────┐
205+
│ fastapi-custom-response │ Async Item Management API with │
206+
│ │ Custom Response System │
207+
│ fastapi-dockerized │ Dockerized FastAPI Item │
208+
│ │ Management API │
209+
│ fastapi-empty │ No description │
210+
│ fastapi-async-crud │ Async Item Management API Server │
211+
│ fastapi-psql-orm │ Dockerized FastAPI Item │
212+
│ │ Management API with PostgreSQL │
213+
│ fastapi-default │ Simple FastAPI Project │
214+
└─────────────────────────┴───────────────────────────────────┘
191215
```
192216

193217
</div>

0 commit comments

Comments
 (0)