Pular para o conteúdo principal

Getting Started

Primeiros passos para executar o projeto localmente e entender como contribuir.

Estrutura do Projeto​

O projeto é construído com a arquitetura JAMStack, usando Docusaurus como framework de documentação.

Instalação​

Instalando o Projeto​

Clone o repositório:

git clone git@github.com:GabriOliv/garden.git

Entre na pasta do projeto:

cd garden

Instale as dependências:

npm install

Execute o projeto localmente:

npm start

Build Local​

Build do projeto:

npm run build

Server com build:

npm run serve

Deployment​

Deploy Automático​

O deploy é feito automaticamente pelo GitHub Actions, após a aprovação do Pull Request.

  • Configuração necessária:
    • Adicionar gh-pages como branch de deploy.
    • Adicionar branch master como branch protegida.

Projeto será publicado na URL: USERNAME.github.io/garden

Contribuindo​

Se você deseja contribuir com o projeto, sinta-se à vontade para abrir um Pull Request ou Issue no repositório com suas sugestões.

Forking do Projeto​

Se você deseja criar um projeto similar, você pode fazer um fork do projeto e adaptar para suas necessidades.

Todo o CI/CD do projeto é feito com o GitHub Actions e o deploy é feito automaticamente para o GitHub Pages. Leia o tópico de Instalação para mais informações.

Você pode realizar o fork do projeto AQUI

Licença​

O projeto é licenciado sob a licença MIT assim como o Docusaurus.