Skip to content

Commit 274d74a

Browse files
authored
📝 Add instructions to README (#12)
1 parent b55326a commit 274d74a

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# fastapi-new
22

3-
Create a new FastAPI project in one command.
4-
5-
✨ Coming soon! ✨
3+
Create a new FastAPI project in one command. ✨
64

75
<a href="https://github.com/fastapi/fastapi-new/actions?query=workflow%3ATest+event%3Apush+branch%3Amain" target="_blank">
86
<img src="https://github.com/fastapi/fastapi-new/actions/workflows/test.yml/badge.svg?event=push&branch=main" alt="Test">
@@ -17,6 +15,40 @@ Create a new FastAPI project in one command.
1715
<img src="https://img.shields.io/pypi/pyversions/fastapi-new.svg?color=%2334D058" alt="Supported Python versions">
1816
</a>
1917

18+
## How to use
19+
20+
Install [uv](https://docs.astral.sh/uv/getting-started/installation/) following their guide for your system.
21+
22+
Run:
23+
24+
```bash
25+
uvx fastapi-new awesomeapp
26+
```
27+
28+
This will create a new project `awesomeapp` with a basic FastAPI app, configured with uv.
29+
30+
Enter the directory:
31+
32+
```bash
33+
cd awesomeapp
34+
```
35+
36+
Run the development server:
37+
38+
```bash
39+
uv run fastapi dev
40+
```
41+
42+
Open your browser and go to `http://localhost:8000` to see your new FastAPI app running! 🚀
43+
44+
### Existing directory
45+
46+
If you want to create a new FastAPI project in an existing directory, run the command without a project name:
47+
48+
```bash
49+
uvx fastapi-new
50+
```
51+
2052
## License
2153

2254
This project is licensed under the terms of the MIT license.

0 commit comments

Comments
 (0)