aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar √Čtienne Deparis 2022-07-12 19:24:03 +0200
committerGravatar √Čtienne Deparis 2022-07-12 19:25:46 +0200
commit97f3623ac9e94b3cde1413286631138f6b54b8e5 (patch)
treeb24fadb269035657ff04419a0f97c99c15cd536e
parent5be899ccfee5a5a7f46ea2228b0cd606e33bed9e (diff)
downloadbiberons-97f3623ac9e94b3cde1413286631138f6b54b8e5.tar.gz
biberons-97f3623ac9e94b3cde1413286631138f6b54b8e5.tar.xz
biberons-97f3623ac9e94b3cde1413286631138f6b54b8e5.zip
doc: Add a README
-rw-r--r--README.org43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..a0472f6
--- /dev/null
+++ b/README.org
@@ -0,0 +1,43 @@
+#+title: Biberon app
+
+A tiny baby feeding tracking web app for their very first weeks.
+
+* Configuration
+
+To work, this application needs the following environment variables to be
+exported:
+
+- ~BIBERON_COOKIE_DOMAIN~ :: domain name of your public instance
+ (i.e. ~mysite.com~), to be used to pin the session cookie to your website
+ only.
+- ~BIBERON_PUBLISH_FOLDER~ :: Where to upload your website (via the
+ ~server:publish~ rake task, which use ~rsync~ internally)
+- ~BIBERON_SESSION_SECRET~ :: Long string use as secret key to encrypt the
+ session cookies.
+
+A quick way to do it locally, is to create a file named ~.env~ at the root of
+this repository, containing the following lines:
+
+#+begin_src
+ export BIBERON_PUBLISH_FOLDER=myserver.com:/opt/web/biberon/
+ export BIBERON_SESSION_SECRET='bliblabluverylongstringohmy'
+ export BIBERON_COOKIE_DOMAIN=127.0.0.1
+#+end_src
+
+* Run
+
+You can start a local server by using the following rake task.
+
+#+begin_src shell
+rake server:start
+#+end_src
+
+You should also try to build the various assets first:
+
+#+begin_src shell
+rake assets:all
+#+end_src
+
+* Credits
+
+- framework CSS: https://milligram.io/