From 5e981bca19ace2a7704f267175b6aa368e63bda0 Mon Sep 17 00:00:00 2001 From: Rubén Beltrán del Río Date: Sat, 18 Feb 2017 17:55:13 -0600 Subject: Initial Setup (#1) * Add git ignore * Add eslint config * Add dummy project files * Add jsdoc config * Add docker files * Add changelog, contributing and readme * Add travis files * Add Paw helper * Add travis test docker compose file * Name the ci service appropriately --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 492e726..7690f61 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ # dead-drop A phone messaging system + +## Configuring + +This project usese environment variables to work. For most cases, the +defaults work but some sensitive info like keys must be overridden. Copy +the file in `config/env.dist` to `.env` in the project root and override +the values. + +When running with `make run`, it'll pick up these values automatically. +If you're doing it the hard way, you'll have to source them. + +## Running Locally + +You'll need [Docker][docker] to run the project. + +* Run the image with `make run` + +## Running locally the hard way + +If you don't want to use docker, you can also run it the old fashioned +way. + +1. Install dependencies with `yarn install` (recommended), or `npm install` +2. Run with `npm start` + +## Generating documentation + +This project uses JSDoc to generate documentation. Generate everything +with `npm run document`. The documentation will be generated in the +`doc` directory. + +## Building and pushing the image + +You can also do some other operations + +* Build the image with `make build` +* Push and build the image with `make upload` +* Clean the environment with `make clean` + +## Setting up Twilio + +TBD + +## Checking the code + +This project uses the [Hapi Style Guide][hapi-style-guide] for +javascript style, and includes eslint configuration to check them. Run +`npm run lint` to check the code. + +[docker]: https://www.docker.com/ +[hapi-style-guide]: https://hapijs.com/styleguide -- cgit