Skip to content

Commit e27071d

Browse files
bnbongbnbong
committed
[FIX] update index.md
1 parent ba1e5f3 commit e27071d

File tree

1 file changed

+99
-58
lines changed

1 file changed

+99
-58
lines changed

‎docs/index.md‎

Lines changed: 99 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -51,65 +51,100 @@ Create a new FastAPI project workspace immediately with:
5151

5252
```console
5353
$ fastkit init
54-
Enter the project name: <your-project-name>
55-
Enter the author name: <your-name>
56-
Enter the author email: <your-email>
57-
Enter the project description: <your-project-description>
54+
Enter the project name: my-awesome-project
55+
Enter the author name: John Doe
56+
Enter the author email: [email protected]
57+
Enter the project description: My awesome FastAPI project
58+
59+
60+
Project Information
61+
┌──────────────┬────────────────────────────┐
62+
│ Project Name │ my-awesome-project │
63+
│ Author │ John Doe │
64+
│ Author Email │ [email protected] │
65+
│ Description │ My awesome FastAPI project │
66+
└──────────────┴────────────────────────────┘
5867

5968
Available Stacks and Dependencies:
60-
MINIMAL Stack
61-
┌──────────────┬─────────┐
62-
│ Dependency 1 │ fastapi │
63-
│ Dependency 2 │ uvicorn │
64-
└──────────────┴─────────┘
65-
66-
67-
STANDARD Stack
68-
┌──────────────┬────────────┐
69-
│ Dependency 1 │ fastapi │
70-
│ Dependency 2 │ uvicorn │
71-
│ Dependency 3 │ sqlalchemy │
72-
│ Dependency 4 │ alembic │
73-
│ Dependency 5 │ pytest │
74-
└──────────────┴────────────┘
75-
76-
77-
FULL Stack
78-
┌──────────────┬────────────────┐
79-
│ Dependency 1 │ fastapi │
80-
│ Dependency 2 │ uvicorn │
81-
│ Dependency 3 │ sqlalchemy │
82-
│ Dependency 4 │ alembic │
83-
│ Dependency 5 │ pytest │
84-
│ Dependency 6 │ redis │
85-
│ Dependency 7 │ celery │
86-
│ Dependency 8 │ docker-compose │
87-
└──────────────┴────────────────┘
69+
MINIMAL Stack
70+
┌──────────────┬───────────────────┐
71+
│ Dependency 1 │ fastapi │
72+
│ Dependency 2 │ uvicorn │
73+
│ Dependency 3 │ pydantic │
74+
│ Dependency 4 │ pydantic-settings │
75+
└──────────────┴───────────────────┘
76+
77+
78+
STANDARD Stack
79+
┌──────────────┬───────────────────┐
80+
│ Dependency 1 │ fastapi │
81+
│ Dependency 2 │ uvicorn │
82+
│ Dependency 3 │ sqlalchemy │
83+
│ Dependency 4 │ alembic │
84+
│ Dependency 5 │ pytest │
85+
│ Dependency 6 │ pydantic │
86+
│ Dependency 7 │ pydantic-settings │
87+
└──────────────┴───────────────────┘
88+
89+
90+
FULL Stack
91+
┌──────────────┬───────────────────┐
92+
│ Dependency 1 │ fastapi │
93+
│ Dependency 2 │ uvicorn │
94+
│ Dependency 3 │ sqlalchemy │
95+
│ Dependency 4 │ alembic │
96+
│ Dependency 5 │ pytest │
97+
│ Dependency 6 │ redis │
98+
│ Dependency 7 │ celery │
99+
│ Dependency 8 │ pydantic │
100+
│ Dependency 9 │ pydantic-settings │
101+
└──────────────┴───────────────────┘
88102

89103

90104
Select stack (minimal, standard, full): minimal
91-
Creating Project:
92-
new-fastapi-project
93-
┌───────────┬────────┐
94-
│ Component │ Status │
95-
│ fastapi │ ✓ │
96-
│ uvicorn │ ✓ │
97-
└───────────┴────────┘
105+
Do you want to proceed with project creation? [y/N]: y
106+
FastAPI project will deploy at '~your-project-path~'
107+
╭─────────────────────────── Info ────────────────────────────╮
108+
│ ℹ Injected metadata into setup.py │
109+
╰─────────────────────────────────────────────────────────────╯
110+
╭─────────────────────────── Info ────────────────────────────╮
111+
│ ℹ Injected metadata into config file │
112+
╰─────────────────────────────────────────────────────────────╯
113+
Creating Project:
114+
my-awesome-project
115+
┌───────────────────┬───────────┐
116+
│ Component │ Collected │
117+
│ fastapi │ ✓ │
118+
│ uvicorn │ ✓ │
119+
│ pydantic │ ✓ │
120+
│ pydantic-settings │ ✓ │
121+
└───────────────────┴───────────┘
98122
Creating virtual environment...
123+
╭─────────────────────────── Info ────────────────────────────╮
124+
│ ℹ venv created at │
125+
│ ~your-project-path~/my-awesome-project/.venv │
126+
│ To activate the virtual environment, run: │
127+
│ │
128+
│ source │
129+
│ ~your-project-path~/my-awesome-project/.venv/bin/activate │
130+
╰─────────────────────────────────────────────────────────────╯
99131
Installing dependencies...
100132
⠙ Setting up project environment...Collecting <packages~>
101133

102134
---> 100%
103135

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-
╰────────────────────────────────────────────────────────────────────╯
136+
╭────────────────────────── Success ──────────────────────────╮
137+
│ ✨ Dependencies installed successfully │
138+
╰─────────────────────────────────────────────────────────────╯
139+
╭────────────────────────── Success ──────────────────────────╮
140+
│ ✨ FastAPI project 'my-awesome-project' has been created │
141+
│ successfully and saved to │
142+
│ ~your-project-path~! │
143+
╰─────────────────────────────────────────────────────────────╯
144+
╭─────────────────────────── Info ────────────────────────────╮
145+
│ ℹ To start your project, run 'fastkit runserver' at newly │
146+
│ created FastAPI project directory │
147+
╰─────────────────────────────────────────────────────────────╯
113148
```
114149

115150
</div>
@@ -125,16 +160,22 @@ Add a new route endpoint to your FastAPI project with:
125160
<div class="termy">
126161

127162
```console
128-
$ fastkit addroute <your-project-name> <new-route-name>
129-
130-
---> 100%
131-
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-
╰────────────────────────────────────────────────────────────────────╯
163+
$ fastkit addroute my-awesome-project user
164+
Adding New Route
165+
┌──────────────────┬──────────────────────────────────────────┐
166+
│ Project │ my-awesome-project │
167+
│ Route Name │ user │
168+
│ Target Directory │ ~your-project-path~ │
169+
└──────────────────┴──────────────────────────────────────────┘
170+
171+
Do you want to add route 'user' to project 'my-awesome-project'? [Y/n]: y
172+
╭─────────────────────────── Info ────────────────────────────╮
173+
│ ℹ Updated main.py to include the API router │
174+
╰─────────────────────────────────────────────────────────────╯
175+
╭────────────────────────── Success ──────────────────────────╮
176+
│ ✨ Successfully added new route 'user' to project │
177+
│ `my-awesome-project` │
178+
╰─────────────────────────────────────────────────────────────╯
138179
```
139180

140181
</div>

0 commit comments

Comments
 (0)