significa.co

Sitio web de significado

Este es el repositorio con el código fuente para el sitio web de Significar, nuestro propio nido en la web. Nos encontramos una obra de arte, pero por supuesto estamos parciales.

Si lo encuentra interesante, inspirador o aprende algo de él, asegúrese de dejar una estrella ️

Arquitectura

Desarrollamos este sitio web utilizando svelte + sveltekit , y una biblioteca de interfaz de usuario personalizada @significa/svelte-ui publicado bajo significado/significado-svelte-ui

Para lograr todas las características, aprovechamos algunos servicios externos:

• CMS - StoryBlok: es donde configuramos el sitio web, construimos páginas, almacenamos y servimos activos.
• Bucket de almacenamiento - AWS S3: Se usa para almacenar archivos adjuntos, cargados a través de los formularios de contacto.
• Envío de correo electrónico - AWS SES: se usa para enviar correos electrónicos de notificación.
• Base de datos NoSQL - AWS Dynamo DB: destinado a almacenar y recuperar los dibujos de huevos "Seggs" dibujados por nuestros usuarios.
• Base de datos de envío del formulario - Nada: creamos una nueva entrada en una base de datos de noción cuando alguien envía un formulario. De esta manera podemos mantener todo en un espacio centralizado.

El sitio web está alojado en VERCEL y se despliega a través de flujos de trabajo de GitHub Actions. Todas las validaciones de integración continua (CI) también se realizan a través de acciones de Gihub.

Tenemos tres entornos distintos para el sitio web:

• local-development para que los desarrolladores desarrollen y prueben su código en su máquina;
• staging limitada a la rama main y las implementaciones de vista previa (solicitudes de extracción);
• production desplegada cuando se publica un lanzamiento.

Esto significa que toda la infraestructura tiene una versión para cada entorno. Incluye claves distintas e externas e integraciones: recursos de AWS, aplicaciones de nociones, bases de datos, etc.

Así es como todo está conectado (las flechas representan el iniciador de solicitud):

Que contribuye

El desarrollo de este proyecto sigue una hoja de ruta interna. Por lo tanto, generalmente solo estamos abiertos a mejoras y arreglos de errores que no tienen un gran impacto en las características o la configuración del proyecto.

Requisitos

• Instale la versión de nodo especificada en el archivo .nvmrc (usando su administrador de versiones de nodo favorito).

• Obtenga el desarrollo local .env usando 1Password-Secrets: 1password-secrets local pull . O crear uno con el ejemplo en .env.example .

• Instale las dependencias con npm install (o npm ci para un archivo de bloqueo congelado).

Desarrollo

• Iniciar el servidor de desarrollo: npm run dev
• Formato automático El código: npm run format

Pruebas y pelusas

• npm run validate
• npm run test

Implementación y lanzamiento

El entorno de puesta en escena está limitado a la rama main , cada nueva adición a esta rama, crea una nueva implementación en la puesta en escena.

Para implementar una nueva versión para la producción, cree un lanzamiento compatible con Semver en GitHub (prefijo con v , por ejemplo: vX.XX ), se implementará automáticamente en producción

Para crear HotFixes:

• Echar el último lanzamiento git checkout vX.XX ;
• Cree una nueva sucursal git checkout -b hotfix/XXXX ;
• Cree un PR a main , obtenga la aprobación y fusione;
• Cree una nueva versión basada en su rama de Hotfix. Use ramas release/xxx para soluciones de lotes juntas.

Licencia

Este material tiene licencia bajo la licencia AGPL, lo que le permite remezclar, aprender y experimentar con él libremente.

Sin embargo, tenga en cuenta que este no es un proyecto tradicional de código abierto; Se describe con mayor precisión como fuente disponible . De acuerdo con la licencia AGPL, la redistribución del código fuente bajo la misma licencia, con atribución al autor original, es obligatoria. Dado que el software solo se puede ofrecer a través de una red, el código fuente debe divulgarse correctamente.

No brindamos apoyo para este proyecto, y la replicación o el cambio de marca se desaniman fuertemente. Sin embargo, lo alentamos a explorar e inspirarnos en cómo construimos nuestro sitio web.