AM-i CRM

environment	url	cloudwatch dashboard	deploy status
dev	Fargate service URL	AWS Cloudwatch dashboard
acc	Fargate service URL	AWS Cloudwatch dashboard

Table of contents

• Getting Started
• Deployment

Getting Started

First, install the dependencies. (Node version 18.x is recommended)

npm install

Generating the types of the api will be handled automatically by "postinstall". However, it is still possible to generate types afterwards by running this npm script.

npm run codegen

Create an enviroment variables file based on the example and fill in the values

cp .env.example .env

Run the development server.

npm run dev

Validate docker image

Build Docker Container:

docker-compose build

Start Docker Container:

docker-compose up -d

Deployment

Build the docker image and dont forget to fill in your token.

docker build -t crm-web-docker --build-arg NPM_TOKEN={GH_ACCESS_TOKEN} .

End-to-End Tests

Follow these steps to run end-to-end tests locally:

1. Run Tests:

   • To run tests:

     npm run test:e2e
     

   • To run tests in headed mode:

     npm run test-headed:e2e
     

2. View Test Reports (Optional):

   • After running tests, the test reports will open automatically.
   • If they don't open, run the following:

     npm run show-e2e-test-report