Merge branch 'release/1.0.0'
📝 Update README
🔧 Update version in package.json
A social network
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
.env in the project root and override
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.
You'll need Docker to run the project.
If you don't want to use docker, you can also run it the old fashioned way.
yarn install(recommended), or
This project uses JSDoc to generate documentation. Generate everything
npm run document. The documentation will be generated in the
You can also do some other operations
This project uses the Hapi Style Guide for
npm run lint to check the code.