https://github.com/utilmeta/utilmeta-py-realworld-example-app
Realworld example demo app backend by UtilMeta Python framework
https://github.com/utilmeta/utilmeta-py-realworld-example-app
Last synced: 10 months ago
JSON representation
Realworld example demo app backend by UtilMeta Python framework
- Host: GitHub
- URL: https://github.com/utilmeta/utilmeta-py-realworld-example-app
- Owner: utilmeta
- License: mit
- Created: 2022-02-16T11:21:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T15:40:40.000Z (over 1 year ago)
- Last Synced: 2025-04-20T17:15:54.020Z (about 1 year ago)
- Language: Python
- Size: 617 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Realworld Example - UtilMeta
* Powered By: [UtilMeta](https://utilmeta.com/py)
UtilMeta | Progressive meta framework for API development in Python
* Implemented [API Specs](https://realworld-docs.netlify.app/docs/specs/backend-specs/endpoints)
* Backend Framwork: [UtilMeta](https://github.com/utilmeta/utilmeta-py)
* Backend Example of [Realworld](https://github.com/gothinkster/realworld)
* Author: [@voidZXL](https://github.com/voidZXL)
* License: MIT
## Installation
```
pip install -r requirements
```
## Env Vars
file in `conduit/config/env.py` shows the env var required for this project
* `CONDUIT_PRODUCTION`: optional, whether if this project is in production mode
* `CONDUIT_JWT_sECRET_KEY`: **required**, configure the JWT secret key for this project
* `CONDUIT_DJANGO_SECRET_KEY`: optional, configure Django secret key for this project
Before you run the server, please configure these env vars
## Database Migration
Migrate database before run the server
```shell
cd conduit
meta migrate
```
## Run
```shell
cd conduit
meta run -d
```
or
```shell
cd conduit
python main.py
```
## OpenAPI Docs
When the server is running, view http://127.0.0.1:8000/api/ops/openapi to get the OpenAPI json docs of this project auto generated by UtilMeta
## Tutorials
There is a tutorial to build this project step by step, you can find it in
* [Realworld Blog Tutorials](https://docs.utilmeta.com/py/en/tutorials/realworld-blog/)
* [Realworld 博客项目教程](https://docs.utilmeta.com/py/zh/tutorials/realworld-blog/)