Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 3.96 KB

README.md

File metadata and controls

97 lines (65 loc) · 3.96 KB
Raw

readme banner with significa's illustrations

Significa website

This is the repository with the source code for Significa's website, our very own nest on the web. We find it a work of art, but of course we are biased.

If you find it interesting, inspiring or learn something from it, make sure to leave a star ⭐️

Architecture

We developed this website using Svelte + SvelteKit, and a custom UI library @significa/svelte-ui published under significa/significa-svelte-ui

To accomplish all features, we leverage a few external services:

  • CMS - Storyblok: It's where we configure the website, build pages, store and serve assets.
  • Storage bucket - AWS S3: Used to store attachments, uploaded via the contact forms.
  • Email dispatcher - AWS SES: Used to dispatch notification emails.
  • NOSQL database - AWS Dynamo DB: Intended to store and retrieve egg drawings "seggs" drawn by our users.
  • Form submission database - Notion: We create a new entry on a Notion database when someone submits a form. This way we can keep everything in a centralized space.

The website is hosted on Vercel, and deployed via GitHub Actions workflows. All Continuous Integration (CI) validations are also made via GiHub Actions.

We have three distinct environments for the website:

  • local-development for developers to develop and test their code on their machine;
  • staging bounded to the main branch and preview deployments (pull requests);
  • production deployed when a release is published.

This means that the whole infrastructure has a version for each environment. Includes distinct keys and external and integrations: AWS resources, Notion applications, databases, etc.

Here's how everything is connected (arrows represent the request initiator):

infrastructure diagram

Contributing

The development of this project follows an internal roadmap. Therefore we usually are only open to improvements and bug-fixes that do not have big impact in the features or project setup.

Requirements

  • Install the node version specified in the .nvmrc file (using your favourite node version manager).

  • Get the local development .env using 1password-secrets: 1password-secrets local pull. Or create one with based on the example in .env.example.

  • Install the dependencies with npm install (or npm ci for a frozen lockfile).

Development

  • Start the development server: npm run dev
  • Auto format the code: npm run format

Testing and linting

  • npm run validate
  • npm run test

Deployment and release

The staging environment is bounded to the main branch, each new addition to this branch, creates a new deployment to staging.

To deploy a new version to production, create a semver compliant release in GitHub (prefixed with v, for example: vX.X.X), it will be deployed automatically to production

To create hotfixes:

  • Check-out to the latest release git checkout vX.X.X;
  • Create a new branch git checkout -b hotfix/XXXX;
  • Create a PR to main, get approval, and merge it;
  • Create a new release based on your hotfix branch. Use release/xxx branches to batch fixes together.

License

This material is licensed under the AGPL License, allowing you to remix, learn, and experiment with it freely.

However, please note that this is not a traditional open-source project; it is more accurately described as source available. In accordance with the AGPL License, redistribution of the source code under the same license, with attribution to the original author, is mandatory. Since the software can only be offered over a network, the source code must be properly disclosed.

We do not provide support for this project, and replication or rebranding is strongly discouraged. However, we encourage you to explore and take inspiration from how we built our website.