summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54132c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Yacos Backend
+
+Yet another Check-Out System
+
+# Setup Dev environment
+## Nix
+
+```console
+nix-shell
+```
+
+## Legacy (untested)
+
+```console
+virtualenv .
+. bin/activate
+pip install django==2.2 djangorestframework django-cors-headers pillow
+```
+
+# Run Dev Build
+
+```
+python manage.py makemigrations
+python manage.py migrate
+python manage.py createsuperuser
+python manage.py runserver &
+firefox localhost:8000
+```