Skip to content

Kingcxp/FastAPI_Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Name

Author: author

Description

Contents of project description

Installation

(You should have python and git installed first)

# Clone this project
git clone https://github.com/gh_user/project_name.git
cd project_name
# create a virtual environment
python3 -m venv serverenv
# activate the virtual environment
# Bash
source serverenv/bin/activate
# Fish
source serverenv/bin/activate.fish
# Powershell
.\serverenv\Scripts\Activate.ps1
# Install dependencies
pip install -r requirements.txt
# Run the server
uvicorn app:app --port 8081 --host 0.0.0.0 --reload

About email

If you want to send emails, you need to create a .env file with the following content:

EMAIL="[email protected]"
EMAIL_PASSKEY="YOUR_PASSKEY"
EMAIL_HOST="smtp.example.com"

Contribute

Pull requests are welcomed. For major changes, please open an issue first to discuss what you would like to change.

About

Template for fastapi projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages