What's Done

Personal activity tracker. Take memos of what I (or we) have done today.

This is my toy project that I experiment different technologies/tools I want to try.

Architecture

flowchart LR
    %% ------------- Actor -----------------
    user([User])

    %% ------------- System boundary -------
    subgraph whats_done["What's Done"]
        direction LR

        subgraph auth["Authentication"]
            cognito["User auth<br/>(Cognito)"]
        end

        %% ----- Front‑end (static site) ----
        subgraph frontend["Frontend"]
            route53_web["Routing<br/>(Route 53)"]
            cloudfront_web["Content delivery<br/>(CloudFront)"]
            s3_web["App<br/>(S3. HTML/CSS/JS)"]

            route53_web --> cloudfront_web --> s3_web
        end

        %% ----- Back‑end (API) -------------
        subgraph backend["Backend"]
            route53_api["Routing<br/>(Route 53)"]
            cloudfront_api["Content delivery<br/>(CloudFront)"]
            apigw["API<br/>(API Gateway. Auth)"]
            lambda_fn["App<br/>(Lambda)"]
            done_db[(Dones)]
            user_db[(Users)]
            xray["Tracing<br/>(X-ray)"]
            cloudwatch_log["Logging<br/>(CloudWatch)"]

            route53_api --> cloudfront_api --> apigw --> lambda_fn
            lambda_fn -- read/write --> done_db
            lambda_fn -- read/write --> user_db
        end
    end

    user --> cognito
    user --> route53_web
    user --> route53_api

Loading

Technology Stack

• infrastructure
  • heroku + MongoDB
  • heroku + DynamoDB
  • AWS Elastic Beanstalk (deployed with kumo) + DynamoDB
  • AWS API Gateway + Lambda + DynamoDB (all deployed with kumo) ⬅️ Now here
    • with other components including: CloudFormation, CloudFront, Route53, X-Ray, Cognito, S3
• backend
  • JavaScript (deployed on AWS Lambda)
  • TypeScript (deployed on AWS Lambda) ⬅️ Now here
• frontend
  • JavaScript + React + flux
  • JavaScript + React + Redux
  • TypeScript + React + Redux ⬅️ Now here

Continuous Integration / Continuous Delivery

Commits to the main branch automatically goes to the production after the successful build/test execution. This includes the changes to the infrastructure.

For CI/CD, What's Done uses GitHub Actions. For more information about CI setup, see its README.

Partial build

To reduce the build time, What's Done CI leverages Build Mate to trigger commands that are relevant to files changed.

Currently, What's Done CI checks git commit range of the current build to find changed files. However, this is sometimes not what you want. To force the build to get the file list of desired commit range, you can include [COMMIT_RANGE:sha1...sha2] in your commit message.

Note that the actual commit used in the build is still HEAD. It is just to make the build to work on different file list.

Deploying entire system

If you want to deploy prod environment, you need to have prod config in modules then execute:

$ AWS_PROFILE=your-profile AWS_REGION=ap-southeast-2 ENV_NAME=prod ./deploy-system.sh

Installing dev dependencies

This project uses mise to install necessary dependencies.

mise trust
mise install

Test

• Unit test: Backend/frontend modules have their own unit test.
• Performance test: Written in Scala using Gatling. see its README.
• End-to-end test: Written in JavaScript. see its README.

Tools

• Migrate done data from mongodb to dynamodb (written in Go). See its README.
• What's Done API Client (written in Haskell). See its README.