mirror of
https://github.com/fastapi-admin/fastapi-admin.git
synced 2026-03-13 10:32:25 +08:00
121 lines
4.2 KiB
Markdown
121 lines
4.2 KiB
Markdown
# FastAPI ADMIN
|
|
|
|
[](https://pypi.python.org/pypi/fastapi-admin)
|
|
[](https://github.com/long2ice/fastapi-admin)
|
|
[](https://github.com/long2ice/fastapi-admin/actions?query=workflow:gh-pages)
|
|
[](https://github.com/long2ice/fastapi-admin/actions?query=workflow:pypi)
|
|
|
|
[中文文档](https://blog.long2ice.cn/2020/05/fastapi-admin%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E5%9F%BA%E4%BA%8Efastapi%E4%B8%8Etortoise-orm%E7%9A%84%E7%AE%A1%E7%90%86%E5%90%8E%E5%8F%B0/)
|
|
|
|
## Introduction
|
|
|
|
FastAPI-Admin is a admin dashboard based on
|
|
[fastapi](https://github.com/tiangolo/fastapi) and
|
|
[tortoise-orm](https://github.com/tortoise/tortoise-orm).
|
|
|
|
FastAPI-Admin provide crud feature out-of-the-box with just a few
|
|
config.
|
|
|
|
## Live Demo
|
|
|
|
Check a live Demo here
|
|
[https://fastapi-admin.long2ice.cn](https://fastapi-admin.long2ice.cn/).
|
|
|
|
- username: `admin`
|
|
- password: `123456`
|
|
|
|
Data in database will restore every day.
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
- [FastAPI](https://github.com/tiangolo/fastapi) framework as your
|
|
backend framework.
|
|
- [Tortoise-ORM](https://github.com/tortoise/tortoise-orm) as your orm
|
|
framework, by the way, which is best asyncio orm so far and I\'m one
|
|
of the contributors😋.
|
|
|
|
## Quick Start
|
|
|
|
### Run Backend
|
|
|
|
Look full example at
|
|
[examples](https://github.com/long2ice/fastapi-admin/tree/dev/examples).
|
|
|
|
1. `git clone https://github.com/long2ice/fastapi-admin.git`.
|
|
2. `docker-compose up -d --build`.
|
|
3. `docker-compose exec -T mysql mysql -uroot -p123456 < examples/example.sql fastapi-admin`.
|
|
4. That's just all, api server is listen at [http://127.0.0.1:8000](http://127.0.0.1:8000) now.
|
|
|
|
### Run Front
|
|
|
|
See
|
|
[restful-admin](https://github.com/long2ice/restful-admin)
|
|
for reference.
|
|
|
|
## Backend Integration
|
|
|
|
```shell
|
|
> pip3 install fastapi-admin
|
|
```
|
|
|
|
```Python
|
|
from fastapi_admin.factory import app as admin_app
|
|
|
|
fast_app = FastAPI()
|
|
|
|
register_tortoise(fast_app, config=TORTOISE_ORM, generate_schemas=True)
|
|
|
|
fast_app.mount('/admin', admin_app)
|
|
|
|
@fast_app.on_event('startup')
|
|
async def startup():
|
|
await admin_app.init(
|
|
admin_secret="test",
|
|
permission=True,
|
|
site=Site(
|
|
name="FastAPI-Admin DEMO",
|
|
login_footer="FASTAPI ADMIN - FastAPI Admin Dashboard",
|
|
login_description="FastAPI Admin Dashboard",
|
|
locale="en-US",
|
|
locale_switcher=True,
|
|
theme_switcher=True,
|
|
),
|
|
)
|
|
```
|
|
|
|
## Documentation
|
|
|
|
See documentation at [https://long2ice.github.io/fastapi-admin](https://long2ice.github.io/fastapi-admin).
|
|
|
|
## Deployment
|
|
|
|
Deploy fastapi app by gunicorn+uvicorn or reference
|
|
<https://fastapi.tiangolo.com/deployment/>.
|
|
|
|
## Restful API Docs
|
|
|
|
See [restful api](https://api-fastapi-admin.long2ice.cn:8443/admin/docs)
|
|
docs.
|
|
|
|
## Support this project
|
|
|
|
| AliPay | WeChatPay | PayPal |
|
|
| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
|
|
| <img width="200" src="https://github.com/long2ice/fastapi-admin/raw/dev/images/alipay.jpeg"/> | <img width="200" src="https://github.com/long2ice/fastapi-admin/raw/dev/images/wechatpay.jpeg"/> | [PayPal](https://www.paypal.me/long2ice) to my account long2ice. |
|
|
|
|
## License
|
|
|
|
This project is licensed under the
|
|
[Apache-2.0](https://github.com/long2ice/fastapi-admin/blob/master/LICENSE)
|
|
License.
|