From 8a576dae76a41cd56f15e14c817a0919cc006e4e Mon Sep 17 00:00:00 2001 From: Jules Laplace Date: Sat, 10 Jun 2017 19:47:40 +0200 Subject: documenting the cms --- README.md | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2159574..eba61cc 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,50 @@ # armory-fmf-cms -## CMS For Find My Face App +## Hansel and Gretel Website + +The Hansel and Gretel Website is a port of the FMF iPad app, minus the face detection features. It uses react-native-web. +This codebase is a fork of the iPad app, with many alterations to make the app work in multiple web environments (desktop, mobile). ### Initial setup +The CMS code relies on a private repository. Please contact Jules for access. + ``` npm install cd client npm install ``` +### Run the CMS + +Create an `.env` file with the following variables: + +``` +S3_KEY= +S3_SECRET= +S3_BUCKET= +S3_DIRNAME= +OK_USER= +OK_PASS= +OK_PRODUCTION=false +MAILGUN_API_KEY= +MAILGUN_DOMAIN= +MAIL_SECRET= +PORT=8100 +WEBHOOK_SECRET=awwSTUDIO +``` + +Then run the CMS: + +``` +npm index +``` + +This will start the CMS running on the port specified, e.g. http://localhost:8100/ + ### Building the client -Build the client locally and push that up. +Build the client locally and push that up to Digital Ocean. ``` cd client @@ -21,7 +53,7 @@ npm web:build git push ``` -### Deploy +### Deploy the changes ``` ssh ja@armory -- cgit v1.2.3-70-g09d2