Setup macOS with Git + Shoreline

[matheusps]

Setup do Mac

1. Instalar o Xcode Command Line Tools xcode-select --install
2. Instalar o Homebrew: https://brew.sh/.
3. Instalar o node com o Homebrew: brew install node.
4. Instalar o pnpm: npm install -g pnpm.
5. Instalar o Github CLI: https://cli.github.com/. brew install gh
6. Instalar o VSCode: https://code.visualstudio.com/.

Clonando o repositório

1. Fazer login com o gh: gh auth login
2. Clonar o repositório: gh repo clone vtex/shoreline

Rodando a documentação

1. Navegar até o shoreline: cd ./shoreline (apenas na primeira vez)
2. Instalar as dependências: pnpm i
3. Buildar os pacotes: pnpm build
4. Rodar a aplicação localmente: pnpm run dev:docs

Explicando a estrutura do nextra

• https://nextra.site/docs

Primeira modificação (commit)

1. Crie uma branch: git checkout -b docs/<nome-da-branch>
2. Abra a pasta clonada no VScode.
3. Altere algum arquivo .mdx dentro de packages/next-docs/pages
4. Adicionar as mudanças feitas no git: git add .
5. Commitar a mudança pnpm commit
6. Subir as mudanças para o github git push --set-upstream origin docs/<nome-da-branch> (mudanças subsequentes podem ser feitas com git push apenas).
7. Abir o PR usando a interface do github

Dicas

Terminais melhores

• https://www.warp.dev/ 🏆
• https://iterm2.com/