mirror of
https://github.com/ycd/manage-fastapi.git
synced 2021-11-08 01:34:39 +03:00
📎 Update README
This commit is contained in:
committed by
Yağızcan Değirmenci
parent
83c90726ec
commit
a20c597384
25
README.md
25
README.md
@@ -17,6 +17,7 @@
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
**Documentation**: View it on [website](https://ycd.github.io/manage-fastapi/)
|
||||
@@ -26,30 +27,46 @@
|
||||
|
||||
---
|
||||
|
||||
<a href="https://asciinema.org/a/377829" target="_blank"><img src="https://asciinema.org/a/377829.svg" /></a>
|
||||
|
||||
## Features 🚀
|
||||
|
||||
* #### Creates customizable **project boilerplate.**
|
||||
* #### Creates customizable **app boilerplate.**
|
||||
* #### Handles the project structuring for you.
|
||||
* #### Optional Dockerfile generation.
|
||||
* #### Optional docker-compose generation for your project needs.
|
||||
* #### Optional pre-commit hook generation.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Manage FastAPI can be installed by running `pip install manage-fastapi`. It requires Python 3.6+ to run.
|
||||
* Prerequisites
|
||||
* Python 3.6 +
|
||||
|
||||
Manage FastAPI can be installed by running
|
||||
|
||||
```python
|
||||
pip install manage-fastapi
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
To get started right away with sensible defaults:
|
||||
|
||||
```bash
|
||||
fastapi startproject {name}
|
||||
fastapi startproject [name]
|
||||
```
|
||||
|
||||
You can run _Manage FastAPI_ as a package if running it as a script doesn’t work:
|
||||
You can also use **interactive** mode!
|
||||
|
||||
```bash
|
||||
python -m fastapi startproject {name}
|
||||
fastapi startproject [name] --interactive
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Command line options
|
||||
|
||||
Manage FastAPI has three commands for now. You can list them by running `fastapi --help`:
|
||||
|
||||
Reference in New Issue
Block a user