significa.co

Site significativo

Este é o repositório com o código -fonte do site da Significa, nosso próprio ninho na web. Achamos uma obra de arte, mas é claro que somos tendenciosos.

Se você achar interessante, inspirador ou aprender algo com ele, não deixe de deixar uma estrela ️

Arquitetura

Desenvolvemos este site usando SVELTE + SVELTEKIT e uma biblioteca de interface do usuário personalizada @significa/svelte-ui publicada sob significativa/significativa-svelte-ui

Para realizar todos os recursos, aproveitamos alguns serviços externos:

• CMS - Storyblok: É onde configuramos o site, criamos páginas, armazenamos e atendemos ativos.
• Balde de armazenamento - AWS S3: Usado para armazenar anexos, carregado através dos formulários de contato.
• Despachante de email - AWS SES: Usado para despachar e -mails de notificação.
• Banco de dados NoSQL - AWS Dynamo DB: destinado a armazenar e recuperar desenhos de ovos "Seggs" desenhados por nossos usuários.
• Banco de dados de envio de formulário - Noção: Criamos uma nova entrada em um banco de dados de noção quando alguém enviar um formulário. Dessa forma, podemos manter tudo em um espaço centralizado.

O site está hospedado no Vercel e implantado por meio de fluxos de trabalho do GitHub Actions. Todas as validações de integração contínua (IC) também são feitas por meio de ações do GiHub.

Temos três ambientes distintos para o site:

• local-development para os desenvolvedores desenvolverem e testam seu código em sua máquina;
• staging limitado à ramificação main e visualização de implantações (solicitações de puxar);
• production implantada quando um lançamento é publicado.

Isso significa que toda a infraestrutura possui uma versão para cada ambiente. Inclui chaves distintas e externos e integrações: Recursos da AWS, aplicativos de noção, bancos de dados, etc.

Veja como tudo está conectado (as setas representam o iniciador de solicitação):

Contribuindo

O desenvolvimento deste projeto segue um roteiro interno. Portanto, geralmente estamos abertos apenas a melhorias e correções de insetos que não têm grande impacto nos recursos ou na configuração do projeto.

Requisitos

• Instale a versão do nó especificada no arquivo .nvmrc (usando seu gerenciador de versão de nó favorito).

• Obtenha o desenvolvimento local .env usando 1Password-Secrets: 1password-secrets local pull . Ou crie um com base no exemplo em .env.example .

• Instale as dependências com npm install (ou npm ci para um arquivo de bloqueio congelado).

Desenvolvimento

• Inicie o servidor de desenvolvimento: npm run dev
• Formato automático O Código: npm run format

Teste e linha

• npm run validate
• npm run test

Implantação e liberação

O ambiente de estadiamento é limitado à filial main , cada nova adição a essa filial, cria uma nova implantação para a encenação.

Para implantar uma nova versão para a produção, crie um lançamento compatível com Semver no GitHub (prefixado com v , por exemplo: vX.XX ), ele será implantado automaticamente na produção

Para criar hotfixes:

• Check-out para a versão mais recente git checkout vX.XX ;
• Crie um novo git checkout -b hotfix/XXXX ;
• Crie um PR para main , obtenha aprovação e mescla;
• Crie uma nova versão baseada na sua filial de hotfix. Use ramificações release/xxx para fazer correções em lote.

Licença

Este material é licenciado sob a licença AGPL, permitindo que você remixe, aprenda e experimente livremente.

No entanto, observe que este não é um projeto de código aberto tradicional; É descrito com mais precisão como fonte disponível . De acordo com a licença AGPL, a redistribuição do código -fonte sob a mesma licença, com atribuição ao autor original, é obrigatória. Como o software só pode ser oferecido em uma rede, o código -fonte deve ser divulgado corretamente.

Não fornecemos suporte para este projeto, e a replicação ou a rebranding é fortemente desencorajada. No entanto, incentivamos você a explorar e se inspirar em como construímos nosso site.