Amplify

Table of Contents

• Getting Started
• Project Setup
• Customize configuration
• App Walkthrough

Getting Started

This repo contains both the frontend and backend portions of the Amplify application.

The frontend code is stored in the src/ directory.

The backend (API) code is stored in the server/ directory.

Project Workflow:

Enablement Deck

• Overall Project Board
• Feature Breakdown
• OSS Architecture
• Wiki: API methods, Data Structures

Resources:

• We meet every Wednesday from 12-1 pm pt and Thursdays from 8-8:30 pm pt. Sign up for an orientation
• Try out our demo or review App Research

Project setup

onboarding.codespaces.mov

Contributing

Would you like to become a contributor? Please check out our contributors guide! 💝

script/bootstrap

You will need to copy the .env.example file to a .env file in this repo.

Compiles and hot-reloads full app for development

npm run dev

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Build and run as if in prod

npm start

Customize configuration

See Configuration Reference.

App Walkthrough

App Structure

Current Structure:

Goal Structure:

User Journey:

GMT20220129-002704_Recording_as_1680x956.mp4

Try out our demo or review App Research

Documenting the API with OpenAPI Schema and Swagger UI

Our API is documented using the OpenAPI 3.1.0 Specification, using a multi-file structure. Linting is enforced by Redocly; you might find it useful to use the Redocly OpenAPI VSCode extension if you are iterating on the schema. See also here for a visual specification reference.

Schema Specification Updates

Updates to the OpenAPI schema itself should be made in the appropriate component .yaml file in the docs/api_docs/ directory. Do not update the top level openapi.yml file; when our automated workflow runs, it will combine all of the files in the docs/api_docs/ into the root-level openapi.yml file. See here for more about the file structure.

Make sure to lint and bundle the API schema locally by running script/lint-and-bundle-openapi-schema.sh. Commit any changes to openapi.yml generated from this command.

You can also explore the components of an OpenAPI spec using this map

The UI spec is viewable here