AQ1 Backend Application

AQ1 Backend Application fetches requiered data from contract and 3rd party oracles to feed the dashboard

Configuration

• Node (>= 16.x.x)
• Yarn
• Express
• Prettier
• Eslint
• TypeScript
• Nodemon
• Jest
• Docker

Scripts

# runn in dev mode
$ yarn run start:dev

# run tests
$ yarn test

# generate code coverage
$ yarn run test-cov

# format code
$ yarn run format

# lint code
$ yarn run lint

# check if code is formatted correctly
$ yarn run check-formatting

# run in production
$ yarn run start:prod

Docker support

• Dockefile for production image.
• Dockerfile.dev for development.

# starts app in debug+watch mode make changes and save to auto reload
$ docker compose up

• .vscode/launch.json has debug config to attach to running docker container for debugging using vscode.

API Calls

{root_url}/dashboard?wallet_address={user_wallet_address}

Retrieves stats including AQ1 holding count. If wallet address is not specified api provides only generic stats abotu AQ1 collection

Notes

• name test files with '.spec.ts' suffix to exclude them in production build.

License

MIT