[rbdr/dead-drop] / README.md

# 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
Commit	Line	Data
dc10b1de RBR	1	# dead-drop
dc10b1de RBR	2	A phone messaging system
5e981bca RBR	3
	4	## Configuring
	5
	6	This project usese environment variables to work. For most cases, the
	7	defaults work but some sensitive info like keys must be overridden. Copy
	8	the file in `config/env.dist` to `.env` in the project root and override
	9	the values.
	10
	11	When running with `make run`, it'll pick up these values automatically.
	12	If you're doing it the hard way, you'll have to source them.
	13
	14	## Running Locally
	15
	16	You'll need [Docker][docker] to run the project.
	17
	18	* Run the image with `make run`
	19
	20	## Running locally the hard way
	21
	22	If you don't want to use docker, you can also run it the old fashioned
	23	way.
	24
	25	1. Install dependencies with `yarn install` (recommended), or `npm install`
	26	2. Run with `npm start`
	27
	28	## Generating documentation
	29
	30	This project uses JSDoc to generate documentation. Generate everything
	31	with `npm run document`. The documentation will be generated in the
	32	`doc` directory.
	33
	34	## Building and pushing the image
	35
	36	You can also do some other operations
	37
	38	* Build the image with `make build`
	39	* Push and build the image with `make upload`
	40	* Clean the environment with `make clean`
	41
	42	## Setting up Twilio
	43
	44	TBD
	45
	46	## Checking the code
	47
	48	This project uses the [Hapi Style Guide][hapi-style-guide] for
	49	javascript style, and includes eslint configuration to check them. Run
	50	`npm run lint` to check the code.
	51
	52	[docker]: https://www.docker.com/
	53	[hapi-style-guide]: https://hapijs.com/styleguide