This is a project with the intention to create a retrospective board where people can join anonymously to create inputs and react to others participants inputs.
First, open your cloned directory, the default directory name is retro-board
(if you have not renamed), access it.
Within this directory we will find two directories, where is our frontend (retro-board-ui
) and our API (retro-board-api
).
$ cd retro-board-ui
$ yarn && yarn start
Start postgres instance:
Note: You need to keep this terminal window/tab opened
$ docker-compose up
Running our API:
$ cd retro-board-api
$ yarn && yarn start
You can access API Docs in http://localhost:8080/api-docs
Seed DB:
yarn premigration:run
yarn seed:run
- Pick an issue that's not assigned to anyone and ask to work on it, so you'll be assigned.
- Make sure to add tests whenever it's possible.
- Use this commit pattern:
[#ISSUE_NUMBER] Your commit message
, example:[#7] Add docker-compose to start postgres
- Have fun! :)