This is a personal learning project created using FastAPI.
Final vision is a web app that allows for tracking stock trading with friends. A user can invite friends, create contests of a certain dollar amount (not real money) with a time length, and a dashboard to allow users to see how well they perform against one another.
This repository is the server side API. Final vision would be a front-end made in React or other framework.
- Very early on.
- Basic users endpoint created.
- Dummy JSON Web Token authentication implemented referencing a dummy DB object
- Basic testing implemented for endpoints that exist.
- More robust authentication incoming.
pip install -r requirements.txt
Required config variables:
MONGODB_URI- URI to connect to MongoDB database.AUTH_SECRET_KEY- Secret key used to sign JSON Web TokenAUTH_ALGORITHM- Algorithm used when signing JSON Web TokenAUTH_ACCESS_TOKEN_EXPIRE_MINUTES- Expiration time for web tokens
Testing config variables:
TEST_MONGODB_URI- MongoDB URI to use when running tests.
uvicorn api.main:app --reload
pytest
Endpoint documentation is available at 127.0.0.1:8000/docs after starting the API.