Git Product home page Git Product logo

antidote-core's Introduction

โ— NOTE - this project has been archived. Please see this blog post for more details. โ—

Antidote-Core

Go Build Status codecov Go Report Card

This repository is where the core services of the Antidote project are maintained. This includes antidoted, which is the primary service for provisioning curriculum content within a Kubernetes infrastructure.

If you're looking for the web front-end for Antidote, that code is maintained in a separate repository: antidote-web.

The Antidote documentation contains additional architectural details.

Hacking

To build antidote-core, you'll need Go installed. Any modern version of Go should suffice, but the "officially" supported version is whatever is listed in the Dockerfile. Within the antidote-core repository, compile binaries with:

make

To run tests:

make test

If you want to run the core server (antidoted) - you'll need to provide a configuration file. Below is a minimal version with only the api service enabled (see the config package for all supported config options):

---
curriculumDir: /path/to/curriculum
instanceId: antidote-dev
enabledServices:
- api
# - stats
# - scheduler

You will also need to run a copy of NATS - this docker one-liner should do the trick:

docker run --rm -d -p 4222:4222 -p 6222:6222 -p 8222:8222 --name nats-main nats

Note that antictl and antidote are also compiled alongside antidoted. They do not have third-party runtime dependencies like antidoted does, but may depend on access to a running antidoted instance in order to be fully functional (especially antictl).

antidote-core's People

Contributors

cloudtoad avatar jameskellynet avatar jnpr-raylam avatar lara29 avatar mierdin avatar tinyfire9 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.