zev/personal_api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
zevav
2019-10-30 15:21:43 +01:00
parent 479c6cd7dc
commit 8628c375ec
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,7 +1,7 @@
# Personal API # Personal API
Make a secured web API that stores and serves up your own personal and professional data! Make a secured web API that stores and serves up your data!
As of the current commit, it's oriented towards powering freelancers' websites. The current schema is oriented towards powering freelancers' websites.
## Installation ## Installation
@@ -64,4 +64,17 @@ As of today the available endpoints are
title: str title: str
description: str description: str
link: str (optional) link: str (optional)
``` ```
## Dependencies
This project relies on the excellent work of
[SQLALchemy](https://www.sqlalchemy.org/),
[Pydantic](https://github.com/samuelcolvin/pydantic/),
[FastAPI](https://fastapi.tiangolo.com/),
[Pytest](https://docs.pytest.org/en/latest/contents.html),
and [Starlette](https://www.starlette.io/)
## Why?
It started as an excuse to get acquainted with FastAPI, as well as to make a front-end first (JAMstack?) personal site.