[rbdr/dasein] / README.md

# dasein
A social network

## 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 JS Doc to generate documentation. Generate everything
with `npm run doc`.

## 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`

## 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
7eb26514 RBR	1	# dasein
7eb26514 RBR	2	A social network
cc69fef4 RBR	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