significa.co

Site Web de signification

Ceci est le référentiel avec le code source du site Web de signification, notre propre nid sur le Web. Nous trouvons que c'est une œuvre d'art, mais bien sûr, nous sommes biaisés.

Si vous le trouvez intéressant, inspirant ou en apprenez quelque chose, assurez-vous de laisser une étoile ️

Architecture

Nous avons développé ce site Web à l'aide de Svelte + Sveltekit , et une bibliothèque d'interface utilisateur personnalisée @significa/svelte-ui publiée sous signification / significa-svelte-ui

Pour accomplir toutes les fonctionnalités, nous tirons parti de quelques services externes:

• CMS - StoryBlok: C'est là que nous configurons le site Web, construisons des pages, stockons et servons des actifs.
• Bodet de stockage - AWS S3: Utilisé pour stocker les pièces jointes, téléchargées via les formulaires de contact.
• Dispatcher des e-mails - AWS SES: Utilisé pour expédier les e-mails de notification.
• NOSQL Database - AWS Dynamo DB: destiné à stocker et à récupérer les dessins d'oeufs "Seggs" dessinés par nos utilisateurs.
• Base de données de soumission de formulaire - Notion: nous créons une nouvelle entrée sur une base de données de notion lorsque quelqu'un soumet un formulaire. De cette façon, nous pouvons tout garder dans un espace centralisé.

Le site Web est hébergé sur Vercel et déployé via des workflows GitHub Actions. Toutes les validations d'intégration continue (IC) sont également effectuées via des actions GiHub.

Nous avons trois environnements distincts pour le site Web:

• local-development pour les développeurs pour développer et tester leur code sur leur machine;
• staging délimitée aux déploiements de branche main et d'aperçu (demandes de traction);
• production déployée lorsqu'une version est publiée.

Cela signifie que toute l'infrastructure a une version pour chaque environnement. Comprend des clés distinctes et des intégrations externes et intégrations: ressources AWS, applications de notion, bases de données, etc.

Voici comment tout est connecté (les flèches représentent l'initiateur de la demande):

Contributif

Le développement de ce projet suit une feuille de route interne. Par conséquent, nous ne sommes généralement ouverts qu'aux améliorations et aux fixations de bogues qui n'ont pas d'impact important sur les fonctionnalités ou la configuration du projet.

Exigences

• Installez la version de nœud spécifiée dans le fichier .nvmrc (en utilisant votre gestionnaire de version de nœud préféré).

• Obtenez le développement local .env en utilisant 1Password-Secrets: 1password-secrets local pull . Ou en créer un avec basé sur l'exemple dans .env.example .

• Installez les dépendances avec npm install (ou npm ci pour un fichier de verrouillage gelé).

Développement

• Démarrer le serveur de développement: npm run dev
• Format automatique Le code: npm run format

Tests et libellés

• npm run validate
• npm run test

Déploiement et libération

L'environnement de stadification est délimité à la branche main , chaque nouvel ajout à cette branche, crée un nouveau déploiement à la mise en scène.

Pour déployer une nouvelle version en production, créez une version conforme à Semver dans GitHub (préfixée avec v , par exemple: vX.XX ), il sera déployé automatiquement en production

Pour créer des chauffages à chaud:

• Découvrez la dernière version git checkout vX.XX ;
• Créez une nouvelle branche git checkout -b hotfix/XXXX ;
• Créez un PR pour main , obtenir l'approbation et le fusionner;
• Créez une nouvelle version basée sur votre branche HotFix. Utilisez les branches release/xxx pour les correctifs par lots ensemble.

Licence

Ce matériel est autorisé sous la licence AGPL, vous permettant de remixer, d'apprendre et de l'expérimenter librement.

Cependant, veuillez noter qu'il ne s'agit pas d'un projet traditionnel open-source; Il est plus précisément décrit comme une source disponible . Conformément à la licence AGPL, la redistribution du code source sous la même licence, avec l'attribution à l'auteur d'origine, est obligatoire. Étant donné que le logiciel ne peut être proposé que sur un réseau, le code source doit être correctement divulgué.

Nous ne soutenons pas ce projet, et la réplication ou le changement de marque est fortement découragé. Cependant, nous vous encourageons à explorer et à vous inspirer de la façon dont nous avons construit notre site Web.