GETTING_STARTED.md

Documentação lombardi-starter

Sumário

• Documentação lombardi-starter
  • Sumário
  • Visão Geral
  • Customizando a Interface
  • Conectando com o Netlify CMS
  • Adicionando o seu conteúdo
  • Dúvidas ou sugestões?

Visão Geral

1. Clone esse repositório utilizando: git clone --depth=1 https://github.com/cassiocardoso/lombardi-starter.git <YOUR_PROJECT_NAME>
2. Entre no diretório que você acabou de clonar: cd <YOUR_PROJECT_NAME>.
3. Instale as dependencias: npm install or yarn.
4. Rode a aplicação: npm run start or yarn start.
   1. O front-end estará rodando em: http://localhost:8000/.
   2. A API GraphQL estará rodando em: http://localhost:8000/___graphql.
   3. O painel de admin (Netlify CMS) estará rodando em: http://localhost:8000/admin/.

Customizando a Interface

Os componentes da interface utilizam a biblioteca Tailwind CSS que pode ser customizada no arquivo: tailwind.config.js. O projeto possui modelos para alguns componentes como header, cor de background, cor principal, tabelas, entre outros. Para customizar o tema, veja a documentação oficial do Tailwind.

Conectando com o Netlify CMS

Para editar o conteúdo do site, sem tocar no código, você precisará ter configurado o deploy da aplicação para o Netlify e, em seguida, configurar a autenticação através do GitHub. Os links abaixo são da documentação oficial do Gatsby e Netlify sobre como fazer isso (ambos em inglês).

• Gatsby: Deploying to Netlify
• Authenticate users with Netlify Identity

Adicionando o seu conteúdo

O projeto usa dados fake para ilustrar o layout, páginas e os widgets.

Para utilizar o seu conteúdo, você tem 2 opções:

1. Editar os arquivos Markdown no diretório content manualmente;
2. Editar o conteúdo pela interface de admin (necessita conectar com o Netlify previamente)

Dúvidas ou sugestões?

Check the issue tracker to see if it's a known issue before creating a new ticket.