Git Product home page Git Product logo

northstar's Introduction

North Star

A discovery service for ForgeFlux ecosystem

Documentation Docker Build codecov

Why

ForgeFlux allows for multiple interfaces to be run against a single software forge. Also, the protocol is flexible enough to support multiple types of software forges(GitLab, GitHub, etc). The protocol's decentralised nature makes it impossible to create a constant record of which interfaces service forges.

So we created a discovery service which stores records of interfaces and the forges they service. This is very similar to the way DNS works. In DNS, hostname is resolved to IP address. Here, software forge URL is resolved to URLs of interfaces that service the queried forge.

Live instance

A live instance is available at https://northstar.forgeflux.org/.

API Specification

OpenAPI specification is available at https://forgeflux-org.github.io/northstar/.

Deployment

Docker images are run against every commit on master. We are currently in alpha status, expect breaking changes while deploying images tagged latest.

We'll freeze code once we have a stable release.

docker run -d \
	-v /path/to/your/northstar/config.toml:/home/northstar/app/config/settings.toml
	-p 3001:3000 \
	forgedfed/northstar

Hacking

This codebase is fairly straight forward, see Makefile for some helpful commands.

northstar's People

Contributors

dat-adi avatar mscherer avatar realaravinth avatar svijayb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

northstar's Issues

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.