Skip to content
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
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# fastapi-new

Create a new FastAPI project in one command.

✨ Coming soon! ✨
Create a new FastAPI project in one command. ✨

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

## How to use

Install [uv](https://docs.astral.sh/uv/getting-started/installation/) following their guide for your system.

Run:

```bash
uvx fastapi-new awesomeapp
```

This will create a new project `awesomeapp` with a basic FastAPI app, configured with uv.

Enter the directory:

```bash
cd awesomeapp
```

Run the development server:

```bash
uv run fastapi dev
```

Open your browser and go to `http://localhost:8000` to see your new FastAPI app running! 🚀

### Existing directory

If you want to create a new FastAPI project in an existing directory, run the command without a project name:

```bash
uvx fastapi-new
```

## License

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