From f6d4831ab70a289376494384b51071839db35de5 Mon Sep 17 00:00:00 2001 From: Stepan Usatiuk Date: Tue, 26 Jun 2018 20:15:24 +0300 Subject: [PATCH] edit readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 74e317c..5283806 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Simple Todo list This is a simple todo list, written in javascript, using express for the backend and react/redux for the frontend. +It also can work in offline, thanks to redux-offline. ## Running it @@ -13,3 +14,19 @@ And visit it at http://localhost:3000 ## Configuration By default development server uses mongodb todolist database at localhost, you can change it with environment variable `DEV_DB_URI` + +If you are running it in production environment, you should set these environment variables: + +``` +HSTS = true/false +MONGODB_URI +PORT +SECRET +``` + +## Offline + +To enable service worker, the frontend should be run in production environment. +To run it locally you should build the frontend: `cd react && npm run build`. + +And visit it at http://localhost:4000