coai

coai is a project that aims to provide a solution for annotating medical data. It allows users to annotate medical images, documents, and other types of data with relevant information for research, diagnosis, and treatment purposes.

Setup

1. Install the AWS CLI
2. Check if you have AWS Credentials using aws sts get-caller-identity. If the Account is correct, skip this. If 'Unable to locate credentials', skip to Step 4.
3. Clear your AWS Credentials:
   • Remove ~/.aws/credentials
   • Remove ~/.aws/config
4. Configure AWS Credentials using the AWS CLI
5. npm i - Install all npm packages

Production Setup

Complete Setup as above.

Mirrors the Amplify buildspec:

3. Complete one of the following:
   1. Pull an existing configuration from 'prod': npm run configure - useful if an up-to-date deployment exists
   2. Deploy the CDK to 'prod': npm run deploy - useful if no deployment is outdated or doesn't yet exist
4. Generate GraphQL types: npm run codegen
5. Build the app: npm run build

Dev Setup

Complete Setup as above.

Mirrors the GitHub Actions workflow:

1. Setup .env files:

   1. In apps/cdk, create a .env file with the following:
      • AWS_ACCOUNT_NO
      • AWS_REGION
      • ENV - should be one of the <stage-name>s defined in apps/cdk/lib/stage.ts
        
   2. In apps/web, create a .env file with the following: - VITE_STAGE - should be one of the <stage-name>s defined in apps/cdk/lib/stage.ts - CODEGEN_DEPTH - the depth of the types generate by npm run codegen. Default = 8
      
      These .env files should never be committed to source control.
      
      ENV and VITE_STAGE are equivalent, and are used to determine which instance of the CDK stack to use. configure, deploy and codegen are reliant on this.

2. Complete one of the following:

   1. Pull an existing configuration: npm run configure - useful if an up-to-date deployment exists
   2. Deploy the CDK to: npm run deploy - useful if no deployment is outdated or doesn't yet exist

3. Generate GraphQL types: npm run codegen

4. Run npm run dev to start the dev server for the web app.

Useful Commands

• npm run test - Runs the test suites.
• npm run deploy - Deploys the CDK stack.
• npm run configure - Pulls the configuration for an existing stack
• npm run lint - Checks code quality, formats and lints the project.
• npm run build - Builds the application.
• npm run dev - Runs the dev server for the web app.