Feat: add a README

2022-12-31 15:03:05 +01:00 · 2022-12-31 15:03:05 +01:00 · b8eef461f8
commit b8eef461f8
parent a953631d19
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,19 @@
 # Recopytex

+One more rewrite of Opytex. This time, it more a learning project than a operational project.
+
+I am following the book *Architecture Patterns with Python* by Harry J.W. Percival and Bob Gregory. Then the project will follow TTD method using DDD.
+
 ## Backend API

+It uses **fastapi**, **sqlalchemy**.
+
+### Installing
+
+    poetry install
+
+### Fire up
+
+    uvicorn backend.api.main:app --reload
+
 ## Frontend