README.md

iris

About

WIP

Architecture

TODO: Add diagram

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Deployment section for on how to deploy the project on a live system.

Development & Testing

Prerequisites

Following are the softwares requried to get everything up and running.

• Docker for Infrastructure Components
• Go for API
• Node.js for UI

Installing

For API

• Install go modules using

go mod download

• Start the API server

make run

For Frontend:

• Install the packages mentioned in package.json file for getting all dependencies of the project.

npm install

• TODO: Configuration
• Start the application

npm start

Deployment

TODO: Add Docker related notes

Issues

Issues are managed via GitHub Issues here.

Maintainers

• Omkar Prabhu

License

TODO: Add license