]> git.r.bdr.sh - rbdr/dasein/blame_incremental - README.md
Add Login (#2)
[rbdr/dasein] / README.md
... / ...
CommitLineData
1# dasein
2A social network
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 JS Doc to generate documentation. Generate everything
31with `npm run doc`.
32
33## Building and pushing the image
34
35You can also do some other operations
36
37* Build the image with `make build`
38* Push and build the image with `make upload`
39* Clean the environment with `make clean`
40
41## Setting up Twitter for login
42
431. Create an app on https://apps.twitter.com/
442. Make sure you check "Allow this application to be used to Sign in with Twitter"
453. Make sure you specify a callback URL (eg. http://localhost:1927/login-callback)
46
47## Checking the code
48
49This project uses the [Hapi Style Guide][hapi-style-guide] for
50javascript style, and includes eslint configuration to check them. Run
51`npm run lint` to check the code.
52
53[docker]: https://www.docker.com/
54[hapi-style-guide]: https://hapijs.com/styleguide