git.r.bdr.sh - rbdr/dasein/blob - README.md

   1 # dasein
   2 A social network
   3
   4 ## Running Locally
   5
   6 You'll need [Docker][docker] to run the project.
   7
   8 * Run the image with `make run`
   9
  10 ## Running locally the hard way
  11
  12 If you don't want to use docker, you can also run it the old fashioned
  13 way.
  14
  15 1. Install dependencies with `yarn install` (recommended), or `npm install`
  16 2. Run with `npm start`
  17
  18 ## Generating documentation
  19
  20 This project uses JS Doc to generate documentation. Generate everything
  21 with `npm run doc`.
  22
  23 ## Building and pushing the image
  24
  25 You can also do some other operations
  26
  27 * Build the image with `make build`
  28 * Push and build the image with `make upload`
  29 * Clean the environment with `make clean`
  30
  31 ## Checking the code
  32
  33 This project uses the [Hapi Style Guide][hapi-style-guide] for
  34 javascript style, and includes eslint configuration to check them. Run
  35 `npm run lint` to check the code.
  36
  37 [docker]: https://www.docker.com/
  38 [hapi-style-guide]: https://hapijs.com/styleguide