Fastapi Web Starter

Please read the Medium article at https://shinichiokada.medium.com/ (Building a Website Starter with FastAPI).

Overview

A static simple website ready to deploy. This repo includes all the file and it is ready to deploy to Heroku.

.env
.gitignore
app
Procfile
README.md
requirements.txt
runtime.txt
static
templates

Requirement

See requirements.txt.

Installation & Usage

$ git clone git@github.com:shinokada/fastapi-web-starter.git
# Or using downloaded zip file 
$ unzip fastapi-web-starter.zip

# change the directory
$ cd fastapi-web-starter
# install packages
$ pip install -r requirements.txt
# start the server
$ uvicorn app.main:app --reload --port 8080

Visit http://127.0.0.1:8080/.

Features

Menu
Unsplash
Accordion
Markdown pages

Test

All tests are under tests directory.

# Change the directory
$ cd fastapi-web-starter
# Run tests
$ pytest -v

Author

twitter

Licence

【MIT License】

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

vincestus / fastapi-web-starter