/co-jist

Primary LanguageCSS

What to eat - Educational side project

This project have two purposes. It serves as a project which should mimic real flow in tech product company as form of mentoring and preparing for future carier of @TerkaSm and @vendy (and hopefully easier entrance to the development world). Second purpouse is to use the application in real life to ease the decision making what to cook and eat.

Repository setup

npm install -g pnpm Note: you can add alias to the terminal config (.bashrc, .zshrc...) like alias pn=pnpm in order to type less...

pnpm install npx dotenv-vault login npx dotenv-vault pull

How to run dev

pnpm dev

Development workflow

Development should be happening on the develop branch. main branch serves as production and is forbiden to push there directly except hotfixes

git checkout develop git checkout -b 'name-of-your-branch' make your changes create commit(s) make a pull request Note: There are automatic end 2 end tests running, when the PR is created or updated

Once the PR is approved and all tests are passing, you can merge it.

Realease to production

Currently we have CI/CD enabled. Once PR is merged to the develop, it will be merged to the main branch. In case of incident, it will be disabled until issue is resolved and commit which cause the issue should be reverted.