Giter VIP home page Giter VIP logo

project-xm's Introduction

project-xm

Prerequisites

  • Docker (with compose support)
  • Go 1.18+
  • GNU Make

Running locally

The following make command is provided for easy deployment on the local machine:

make docker/build docker/run

This should automatically build the project and launch all the necessary containers in Docker.

You can see all available commands along with a short help text simply by typing make.

For testing, you can use any valid HS256 JWT created with the secret key from config.json (supersecret is the default), such as this one:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.rf0rI9lvdgd91-qfOjv4ChS0JHRWK2qeZMqTiMvvF5Q

Running in production

  1. Build the Docker image using make docker/build
  2. Optionally, tag the image with appropriate name for your container registry
  3. Deploy to Compose, Kubernetes, or plain Docker

Tests

  1. Run unit tests using make unittest
  2. Run integration tests using make integration-test. These tests will run in a docker container using postgres database image
  3. Run all tests using make test

TODOs

  • Better error handling & logging (i.e. return proper HTTP error codes for low-level errors)
  • Stricter JWT validation
  • GRPC delivery layer
  • Atomic mutations & events (outbox table?)
  • Add actual Kafka support

project-xm's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.