mirror of
https://github.com/fastapi-admin/fastapi-admin.git
synced 2025-08-06 18:49:47 +08:00
74 lines
2.1 KiB
Markdown
74 lines
2.1 KiB
Markdown
# FastAPI Admin
|
|
|
|
[](https://pypi.python.org/pypi/fastapi-admin)
|
|
[](https://github.com/fastapi-admin/fastapi-admin)
|
|
[](https://github.com/fastapi-admin/fastapi-admin/actions?query=workflow:deploy)
|
|
[](https://github.com/fastapi-admin/fastapi-admin/actions?query=workflow:pypi)
|
|
|
|
[中文文档](./README-zh.md)
|
|
[한국어 문서](./README-ko.md)
|
|
[日本語ドキュメント](./README-ja.md)
|
|
|
|
## Introduction
|
|
|
|
`fastapi-admin` is a fast admin dashboard based on [FastAPI](https://github.com/tiangolo/fastapi)
|
|
and [TortoiseORM](https://github.com/tortoise/tortoise-orm/) with [tabler](https://github.com/tabler/tabler) ui,
|
|
inspired by Django admin.
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
> pip install fastapi-admin
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- [Redis](https://redis.io)
|
|
|
|
## Online Demo
|
|
|
|
You can check a online demo [here](https://fastapi-admin.long2ice.io/admin/login).
|
|
|
|
- username: `admin`
|
|
- password: `123456`
|
|
|
|
Or pro version online demo [here](https://fastapi-admin-pro.long2ice.io/admin/login).
|
|
|
|
- username: `admin`
|
|
- password: `123456`
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
## Run examples in local
|
|
|
|
1. Clone repo.
|
|
2. Create `.env` file.
|
|
|
|
```dotenv
|
|
DATABASE_URL=mysql://root:123456@127.0.0.1:3306/fastapi-admin
|
|
REDIS_URL=redis://localhost:6379/0
|
|
```
|
|
|
|
3. Run `docker-compose up -d --build`.
|
|
4. Visit <http://localhost:8000/admin/init> to create first admin.
|
|
|
|
## Documentation
|
|
|
|
See documentation at <https://fastapi-admin-docs.long2ice.io>.
|
|
|
|
## License
|
|
|
|
This project is licensed under the
|
|
[Apache-2.0](https://github.com/fastapi-admin/fastapi-admin/blob/master/LICENSE)
|
|
License.
|
|
|
|
## Credits
|
|
|
|
[](https://yxvm.com/)
|
|
|
|
[NodeSupport](https://github.com/NodeSeekDev/NodeSupport) supports this project.
|