docs: local setup

2024-01-05 19:51:17 +05:30
parent 4b429263ff
commit d8604a9b9b
1 changed files with 8 additions and 0 deletions
--- a/api/README.md
+++ b/api/README.md
@@ -0,0 +1,8 @@
+## Maxon API
+
+
+### Local Setup 
+
+1. Activate the virtual environment
+2. To install dependencies, run `pip install -r requirements.txt`
+3. Run the command `uvicorn app.main:app --reload`