https://github.com/king-sj/quart-template
A web server template writed by python-quart
https://github.com/king-sj/quart-template
Last synced: about 1 month ago
JSON representation
A web server template writed by python-quart
- Host: GitHub
- URL: https://github.com/king-sj/quart-template
- Owner: King-sj
- License: mpl-2.0
- Created: 2025-01-30T07:36:22.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-03-07T09:56:43.000Z (3 months ago)
- Last Synced: 2025-05-07T01:09:44.688Z (about 1 month ago)
- Language: Python
- Size: 104 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quart Template
A web server template written using Python Quart.
## Environment
- Python 3.13.1
## Set Environment Variables
可以使用如下4个文件设置相应的环境变量：
- <.env>
- <.env.dev>
- <.env.prod>
- <.env.test>
## Installation
1. Clone the repository:
```sh
git clone https://github.com/King-sj/quart-template.git
cd quart-template
```
2. Create and activate a virtual environment:
```sh
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. Install the dependencies:
```sh
pip install -r requirements.txt
```
## Running the Application
1. Set the environment variables:
```sh
cp .env.example .env
# Edit the .env file to configure your environment variables
```
2. Run the application:
```sh
python run.py
```
## Project Structure
```
quart-template/
├── __pycache__/
├── .env
├── .env.dev
├── .env.prod
├── .env.test
├── .github/
├── .gitignore
├── .pre-commit-config.yaml
├── .pytest_cache/
├── .vscode/
├── docs/
├── ksj.session.sql
├── LICENSE
├── logs/
├── main.session.sql
├── migrations/
├── postgres.session.sql
├── pyproject.toml
├── pytest.ini
├── README.md
├── requirements.txt
├── run.py
├── settings.py
├── sql/
├── src/
│ ├── app.py
│ ├── args.py
│ ├── auth/
│ ├── configs/
│ ├── controllers/
│ ├── globals/
│ ├── models/
│ ├── plugins/
│ ├── types/
│ ├── utils/
│ └── __init__.py
├── static/
├── templates/
├── tests/
└── tmp/
```
## Running Tests
To run the tests, use the following command:
```sh
pytest
```
## License
This project is licensed under the terms of the Mozilla Public License Version 2.0.
## more docs
look the file in dir docs