Aperture Public

Setup

Install all of the OS-level dependecies:

• Git, Node, NPM, n-version manager, Docker, Docker Compose, Terraform
• VS Code, or another editor with TS, ESLint, and Prettier support

Switch to the monorepo Node version:

n $(cat .node-version)

Install global monorepo dependencies:

npm install -g @microsoft/rush pnpm prettier

Scripts

rush update                           # Install monorepo NPM dependencies
rush update --full                    # Forcefully re-install and re-link all dependencies

rush start                            # Start everything
rush start --to="<NPM package>"       # Start a specific app
rush start:docker                     # Start up Docker dev environment

rush format:check                     # Check for Prettier issues
rush format:fix                       # Fix Prettier issues
rush lint                             # Check for ESLint issues
rush test                             # Run all unit tests
# rush e2e                            # Run Cypress functional tests
# rush e2e:watch                      # Run Cypress functional tests (watch mode)
rush tsc                              # Start Typescript compiler

rush purge                            # Remove all dependencies

Code organization

/apps                         # Browser and native apps, backend services, lambdas
  /api-gateway                # GraphQL endpoint
  /client-web                 # Main web client

/modules                      # Libraries, frameworks, shared configs, utilities
  /build-tools                # Shared build utils and configs (ESBuild, Typescript, etc.)
  /eslint-config              # Monorepo ESLint config
  /example-react-library      # Example React library
  /terraform                  # Terraform modules