/backend

Primary LanguageTypeScript

Mainframe

Build Status codecov Codacy Badge Conventional Commits

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.


What

This repository contains the code for Vincipit's backend. It is build to support the federation of all of Vincipit's devices, wherever they may be


How

The entire project is containerized using Docker Compose. To run it, simply type

The tech stack is:

  • MongoDB (the main database)
  • NestJS (API framework) + GraphQL
  • Traefik (Network Proxy)
  • InfluxDB (Analytics collection from Traefik)
  • Grafana (Analytics data-viz using InfluxDB)

Run Your Own!

Running an instance of this repository is quite simple

  • Clone it git clone git@git.github.com/vivitek/backend.git
  • Add a DOMAIN key with the base domain you want your instance to use (for example vivi.local) to the .env
  • docker-compose up -d

And you're all set!