search

seasketch / next

A modernization version of the SeaSketch platform, released in 2022.
https://seasketch.org
BSD 3-Clause "New" or "Revised" License
7 stars 1 forks source link

readme

SeaSketch Next

This project consists of multiple packages in a monorepo configuration.

packages/api

This is the core server package. It include a GraphQL API server based on Postgraphile, and all database migrations. It also includes an exported node api (@seasketch/api) that can be used by other services to access and manipulate application data.

packages/client

Single-page-app style javascript client built using Create React App.

packages/infra

CDK App that defines the production hosting infrastructure

packages/lambda-db-client

Provides a reusable method of connecting to the production SeaSketch database from Lambda services.

packages/emailStatusHandler

Lambda microservice for updating project and survey invite status based on SNS notifications from AWS SES.

Development Environment Setup

There are a lot of build scripts and dev servers needed to run the entire stack. If you have Docker installed and use VSCode a lot of this setup can be started for you by simply opening the root of the project in your editor. Run the VSCode command "Manage Automatic Tasks in Folder" and choose allow to run the necessary build tasks and development servers.

Follow this guide in order to setup appropriate environment variables for development.

Deployments

This project is managed using the GitHub Flow pattern and GitHub Actions. To make changes...

  1. Do work on a feature branch and create a pull request
  2. Ensure automated checks pass, including unit and end-to-end tests
  3. Checkout the Deployment Options Summary to see how changes will impact production.
  4. Within GitHub, go to Actions / Create Deployment and run the workflow on your branch.

In general, try not to merge directly into master, but if you do, make absolutely certain all changes are deployable. When using a feature branch, it's easy to roll back a bad deployment. All you need to do is run the Create Deployment workflow on master, which should be ready to deploy if the rules are followed. Alternatively, you could create a new branch from a previous commit if broken changes are at the HEAD.

Deployment Options Summary

This summary is generated for every commit and will flag what services will be updated.