README.md

XebiKart - Dashboard for Xebikart project

Technical stack:

• React
• Communicates with backend via Server Side Events

---

Howto to run it?

This dashboard is served by an Nginx server which listen on port 80 (port currently exposed by the container).

Properties/Environment varirables

Name	Default value	Comment/Descibe
BACKEND_HOST		Hostname of backend to send API request
BACKEND_PORT		Port of backend to send API request

Sample run command with docker

docker run -d -p 8080:80 -e "BACKEND_HOST=backend.prv" -e "BACKEND_PORT=8080" xebikart/dashboard:dev

How to build it?

Using Make, Yarn and Docker:

make docker

Using Make inside a Docker build container:

make docker DOCKERIZE=1

If you would like to specify a version to your image, you can use VERSION argument like this:

make docker VERSION=dev

It will produce an image with following tag : xebikart/dashboard:dev

Architectural Decision Records

You may find our ADRs in the doc/adr/ directory:

r Use SSE as echange data technology between back and front

Communication

You could join us on slack xebiafr channel #xebikart-dashboard or by mention @xebikart-team-dashboard .

Continuous Integration

The Continuous Integration for this project is done with CircleCI, which is the most awesome SaaS CI at this moment :)

In the jobs/workflow, we'll make a heavy use of CircleCI Orbs, which is a good thing because we're doing standard things in a standard way. We're essentially just wrapping calls that we could do ourselves on whatever other CI out there such as docker build [...], gcloud auth [...] or kubectl apply [...]

Features used:

• Docker layer caching
• Orbs (Intro / Registry]
  • gcp-gcr to build Docker images and push them to GCR