aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d723d87
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# tomi.science
+
+## Running
+
+### Frontend
+
+Next.js + socket.io.
+
+- Install packages: `npm ci`
+- In development: `npm run dev`
+- In production: `npm run build && npm start`
+
+### Backend
+
+Express + socket.io + slonik. You need a Postgres db (you can use docker compose).
+
+- Install packages: `npm ci`
+- Run migrations `npm run migrate -- up`
+- In development: `npm run dev`
+- In production `NODE_ENV=production npm start`
+
+## Author
+
+Jan Tuomi <<jans.tuomi@gmail.com>>