https://github.com/terkasm/co-jist

https://github.com/terkasm/co-jist

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/terkasm/co-jist
• Owner: TerkaSm
• Created: 2023-12-20T13:02:36.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-06T11:29:53.000Z (about 1 year ago)
• Last Synced: 2024-11-05T11:15:24.756Z (2 months ago)
• Language: CSS
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

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