Este repositório é um projeto open source que utiliza o Figma Kit da Relume para criar componentes em HTML e CSS. A ideia é que a comunidade faça forks, crie suas próprias branches, contribua com novos componentes e abra Pull Requests para revisão e aprovação.
-
Faça um Fork do Repositório:
- Clique no botão "Fork" no canto superior direito desta página para criar uma cópia deste repositório em sua conta do GitHub.
-
Clone o Repositório Forkado:
- Clone o repositório para sua máquina local.
git clone https://github.com/seu-usuario/relume-figma-kit.HTML cd relume-figma-kit.HTML
-
Crie uma Nova Branch:
- Crie uma nova branch para o seu componente.
git checkout -b feat/nome-do-componente
-
Adicione Seu Componente:
- Crie uma nova pasta dentro de
src/components/
com o nome do seu componente. - Dentro dessa pasta, adicione os arquivos
index.html
estyles.css
. - Siga o padrão de estrutura de pastas demonstrado na captura adicionada.
- Crie uma nova pasta dentro de
-
Exporte e Adicione Imagens SVG:
- Exporte todas as imagens usadas no seu componente como arquivos SVG e coloque-os dentro da pasta
src/assets/images/
.
- Exporte todas as imagens usadas no seu componente como arquivos SVG e coloque-os dentro da pasta
-
Adicione o CSS Global:
- No seu arquivo
index.html
, importe o CSS global para garantir a padronização dos estilos:
<link rel="stylesheet" href="../../style/global.css">
- No seu arquivo
-
Faça o Commit das Suas Alterações:
- Faça o commit das suas alterações com uma mensagem descritiva.
git add . git commit -m "Adicionei componente [nome-do-componente]"
-
Faça o Push da Sua Branch:
- Envie suas alterações para o GitHub.
git push origin feat/nome-do-componente
-
Abra um Pull Request:
- No repositório original, abra um Pull Request para que sua contribuição possa ser revisada e aprovada.
relume-figma-kit.HTML/
│
├── src/
│ ├── assets/
│ │ └── images/
│ │ ├── company-logo.svg
│ │ ├── facebook.svg
│ │ ├── instagram.svg
│ │ ├── linkedin.svg
│ │ ├── x.svg
│ │ └── youtube.svg
│ │
│ ├── components/
│ │ └── marketing-components/
│ │ └── footer-one/
│ │ ├── index.html
│ │ └── styles.css
│ │
│ └── style/
│ └── global.css
│
├── index.html
├── LICENSE
└── README.md
- Todos os componentes devem ser criados em uma nova pasta dentro de
src/components/
. - Cada componente deve conter um
index.html
e umstyles.css
. - As imagens devem ser exportadas como SVG e colocadas em
src/assets/images/
. - O CSS global deve ser importado em todos os arquivos HTML.
- Mantenha seu código limpo e bem documentado.
Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para mais detalhes.