From 19f8840612c4071889df7cd90c090c74d9079376 Mon Sep 17 00:00:00 2001 From: MRyutaro Date: Thu, 29 Aug 2024 17:15:41 +0900 Subject: [PATCH] add: new README by japanese --- README-ja.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README-ko.md | 1 + README-zh.md | 4 ++++ README.md | 1 + 4 files changed, 69 insertions(+) create mode 100644 README-ja.md diff --git a/README-ja.md b/README-ja.md new file mode 100644 index 0000000..257422f --- /dev/null +++ b/README-ja.md @@ -0,0 +1,63 @@ +# FastAPI Admin + +[![image](https://img.shields.io/pypi/v/fastapi-admin.svg?style=flat)](https://pypi.python.org/pypi/fastapi-admin) +[![image](https://img.shields.io/github/license/fastapi-admin/fastapi-admin)](https://github.com/fastapi-admin/fastapi-admin) +[![image](https://github.com/fastapi-admin/fastapi-admin/workflows/deploy/badge.svg)](https://github.com/fastapi-admin/fastapi-admin/actions?query=workflow:deploy) +[![image](https://github.com/fastapi-admin/fastapi-admin/workflows/pypi/badge.svg)](https://github.com/fastapi-admin/fastapi-admin/actions?query=workflow:pypi) + +[中文文档](./README-zh.md) +[한국어 문서](./README-ko.md) +[日本語ドキュメント](./README-ja.md) + +## はじめに + +`fastapi-admin`は、[tabler](https://github.com/tabler/tabler)UIを使用して開発された[FastAPI](https://github.com/tiangolo/fastapi)と[TortoiseORM](https://github.com/tortoise/tortoise-orm/)の高速な管理ダッシュボードで、Django adminを参考にしています。 + +## インストール + +```shell +> pip install fastapi-admin +``` + +## 環境 + +- [Redis](https://redis.io) + +## オンラインデモ + +[ここ](https://fastapi-admin.long2ice.io/admin/login)でオンラインデモを確認できます。 + +- username: `admin` +- password: `123456` + +もしくは、[ここ](https://fastapi-admin-pro.long2ice.io/admin/login)でプロ版のオンラインデモを確認できます。 + +- username: `admin` +- password: `123456` + +## スクリーンショット + +![](https://raw.githubusercontent.com/fastapi-admin/fastapi-admin/dev/images/login.png) + +![](https://raw.githubusercontent.com/fastapi-admin/fastapi-admin/dev/images/dashboard.png) + +## ローカル環境での実行方法 + +1. レポジトリをクローンする。 +2. .envファイルを作成し、以下の内容を記述する。 + + ```dotenv + DATABASE_URL=mysql://root:123456@127.0.0.1:3306/fastapi-admin + REDIS_URL=redis://localhost:6379/0 + ``` + +3. `docker-compose up -d --build`を実行する。 +4. にアクセスして、管理者用アカウントを作成する。 + +## ドキュメント + +ドキュメントは[こちら](https://fastapi-admin-docs.long2ice.io)で確認できます。 + +## ライセンス + +このプロジェクトは、[Apache-2.0](https://github.com/fastapi-admin/fastapi-admin/blob/master/LICENSE)ライセンスに準拠しています。 diff --git a/README-ko.md b/README-ko.md index 45127ab..a5d28f1 100644 --- a/README-ko.md +++ b/README-ko.md @@ -7,6 +7,7 @@ [中文文档](./README-zh.md) [한국어 문서](./README-ko.md) +[日本語ドキュメント](./README-ja.md) ## 개요 diff --git a/README-zh.md b/README-zh.md index caf8763..416308a 100644 --- a/README-zh.md +++ b/README-zh.md @@ -5,6 +5,10 @@ [![image](https://github.com/fastapi-admin/fastapi-admin/workflows/gh-pages/badge.svg)](https://github.com/fastapi-admin/fastapi-admin/actions?query=workflow:gh-pages) [![image](https://github.com/fastapi-admin/fastapi-admin/workflows/pypi/badge.svg)](https://github.com/fastapi-admin/fastapi-admin/actions?query=workflow:pypi) +[中文文档](./README-zh.md) +[한국어 문서](./README-ko.md) +[日本語ドキュメント](./README-ja.md) + ## 简介 `fastapi-admin` 是一个基于 [FastAPI](https://github.com/tiangolo/fastapi) diff --git a/README.md b/README.md index f4e150e..6c9ef49 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ [中文文档](./README-zh.md) [한국어 문서](./README-ko.md) +[日本語ドキュメント](./README-ja.md) ## Introduction