xBoard

Project team management board for efficient allocation of developer resources to ongoing and upcoming projects

Table of contents

• Getting started
  • Setup
  • Compiling protocol buffers
• Running tests
  • Unit tests
  • E2E Tests
    • Cypress
• Deployment
• Built With
• Contributing
• License

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 for notes on how to deploy the project on a live system.

Setup

To run this project on a local machine, simply run

docker-compose up --build

from the project's root directory.

Compiling protocol buffers

Each change to the .proto files in the services requires a compilation of the protocol buffers into Angular code.

Instructions:

1. Install protoc according to these instructions.
2. Run yarn proto:generate in frontend folder.

Running tests

Unit tests

To run tests locally, run

yarn test

in the frontend or any of the services directories.

E2E Tests

Cypress

• yarn cy:run
• yarn cy:open

Deployment

TBD

Built With

• Nest.js on the backend, using microservices
• gRPC for service and client communication
• Angular on the frontend
• Envoy proxy
• ngx-grpc

Contributing

TBD

License

This project is licensed under the terms of the MIT license.