add README

Firebird1029 · Feb 20, 2024 · 2689217 · 2689217
1 parent 76cc1cb
commit 2689217
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/README b/README
@@ -0,0 +1,31 @@
+# README
+
+## Backend
+
+To run the backend server:
+
+```bash
+cd backend
+FLASK_APP=server flask run
+```
+
+To lint the backend code:
+
+```bash
+python -m pylint *.py
+```
+
+## Frontend
+
+To run the frontend application:
+
+```bash
+cd frontend
+npm run dev
+```
+
+To lint the frontend code:
+
+```bash
+npm run lint
+```