From c737818ce4a137d5bcb0572b614b5ee0ae09d5b1 Mon Sep 17 00:00:00 2001 From: Johannes Date: Tue, 20 Sep 2022 16:59:42 +0200 Subject: [PATCH] add some documentation for getting started with development This is really not hard, but even easier if one sees directly what to do. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6a248d --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Sprechstundentool der FS Mathematik TU Darmstadt + +## Developing +Make sure you have [Go installed](https://go.dev/doc/install), +e.g. by executing `go version`. + +Initialize the database. For developing, we recommend using sqlite: + + user@host:path/to/repo$ sqlite3 officeHours.db -init sqlite.sql + sqlite> .read dummydatasqlite.sql + +Now start the development webserver, note that you need to manually +restart it to code changes take effect. + + go run . + +The website is exposed at , this (and some other options, +e.g. where mails are sent to) can be adjusted in `config/config.json`.