]> git.r.bdr.sh - rbdr/dead-drop/blame - README.md
Initial Setup (#1)
[rbdr/dead-drop] / README.md
CommitLineData
dc10b1de
RBR
1# dead-drop
2A phone messaging system
5e981bca
RBR
3
4## Configuring
5
6This project usese environment variables to work. For most cases, the
7defaults work but some sensitive info like keys must be overridden. Copy
8the file in `config/env.dist` to `.env` in the project root and override
9the values.
10
11When running with `make run`, it'll pick up these values automatically.
12If you're doing it the hard way, you'll have to source them.
13
14## Running Locally
15
16You'll need [Docker][docker] to run the project.
17
18* Run the image with `make run`
19
20## Running locally the hard way
21
22If you don't want to use docker, you can also run it the old fashioned
23way.
24
251. Install dependencies with `yarn install` (recommended), or `npm install`
262. Run with `npm start`
27
28## Generating documentation
29
30This project uses JSDoc to generate documentation. Generate everything
31with `npm run document`. The documentation will be generated in the
32`doc` directory.
33
34## Building and pushing the image
35
36You 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
44TBD
45
46## Checking the code
47
48This project uses the [Hapi Style Guide][hapi-style-guide] for
49javascript 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