From c8a90295cfa43383bf28021c4831a228d840e819 Mon Sep 17 00:00:00 2001 From: Jesper Hess Nielsen Date: Mon, 6 Feb 2017 13:41:19 +0100 Subject: [PATCH] Add README file --- 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..566c242 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# The data.coop website + +## Building the site + +The site is built using [Jekyll](https://jekyllrb.com) +The simplest way to work with the site and code is to use Docker. + +```git clone https://git.data.coop/data.coop/website.git data.coop +cd data.coop +docker-compose up``` + +This will fire up the website inside a Docker container and start listening on port 4000. +Simply connect your browser to http://localhost:4000 and you're good to go. In development +mode, the site has the [jekyll:livereload](https://github.com/RobertDeRose/jekyll-livereload) extension enabled, allowing you to see your changes immediately +upon saving files in the source directory. + +## Deploying the site +TODO: Set up webhook for auto-deployment on push to master. \ No newline at end of file