Merge pull request #1 from itayB/readme

fix(readme): init
itayB · Apr 3, 2024 · 0d03583 · 0d03583
2 parents de2c3ea + 0312784
commit 0d03583
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# A FastAPI Server with a packaged React Application
+
+A simple demo server for demonsrating how to use a packaged [frontend application](https://github.com/itayB/vite-project).
+
+## Getting Started
+
+### Usage
+
+You can install this server and run it with:
+
+```shell
+pip install -r requirements.txt
+python -m backend
+```
+
+## Contribution
+
+### Installation
+
+```shell
+pip install -r requirements.txt
+```