Giter Site home page Giter Site logo

danivideda / catalyst-core Goto Github PK

View Code? Open in Web Editor NEW

This project forked from input-output-hk/catalyst-core

0.0 0.0 0.0 667 MB

⚙️ Core Catalyst Governance Engine and utilities.

Home Page: https://input-output-hk.github.io/catalyst-core

License: Apache License 2.0

Shell 1.08% JavaScript 0.67% Python 5.74% Perl 0.01% C 0.22% Objective-C 0.26% Rust 89.92% Kotlin 0.72% CSS 0.42% Nix 0.32% Handlebars 0.15% PLpgSQL 0.09% Dockerfile 0.11% Earthly 0.29%

catalyst-core's Introduction

Catalyst Core

Core Catalyst Governance Engine and utilities

Current CI Status. Catalyst Core is released under either of Apache License, Version 2.0 or MIT license at your option.. PRs welcome! Coverage Status OpenSSF Scorecard

Content

What's inside?

Requirements

Development

Earthly

Note: This is the preferred development environment.

Make sure that docker is running and then run:

# This command can take a while to run.
earthly +local

then run:

docker-compose -f local/docker-compose.yml up

You should now be able to use Catalyst Core API V1 locally:

Open a new terminal window and run:

curl --request GET \
  --url http://localhost:3030/api/v1/events \
  --header 'Accept: application/json'

you should get list of events:

[
  {
    "id": 0,
    "name": "Catalyst Fund 0",
    "starts": "2020-05-22T00:00:00+00:00",
    "ends": "2020-06-24T00:00:00+00:00",
    "final": true
  },
  {
    "id": 1,
    "name": "Catalyst Fund 1",
    "starts": "2020-08-08T00:00:00+00:00",
    "ends": "2020-09-22T00:00:00+00:00",
    "final": true
  },
.
.
.
.
  {
    "id": 9,
    "name": "Catalyst Fund 9",
    "starts": "2022-06-02T00:00:00+00:00",
    "ends": "2022-10-11T00:00:00+00:00",
    "final": true
  }
]

Manual

Prerequisites

Linux
sudo apt install -y protobuf-compiler libssl-dev libpq-dev libsqlite3-dev pkg-config
macOS
brew install protobuf-c libsigsegv libpq libserdes pkg-config
Windows
choco install protoc openssl sqlite postgresql14

Nix

⛔️ Note: Nix packaging code is deprecated and will be removed in a future.

  • Install Nix
  • Start a nix development environment (from the repo root): nix develop

Install Extra Packages/Tools

This only needs to be done once when the development environment is created.

  • cargo install cargo-binstall --locked
  • cargo binstall --no-confirm cargo-make
  • cargo make install-prereqs

Building Documentation

If you have edited any of the documentation, then it needs to be updated by running:

cargo make build-docs

Any update files need to be committed to the repo. (until we have this integrated with CI).

Support

Post issues and feature requests on the GitHub issue tracker.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

catalyst-core's People

Contributors

cameron1024 avatar codesandwich avatar cong-or avatar const-iohk avatar dependabot-preview[bot] avatar dependabot[bot] avatar dkijania avatar ecioppettini avatar edolstra avatar eugene-babichenko avatar feliperosa avatar filip-dulic-bloxico avatar garbas avatar github-actions[bot] avatar iquerejeta avatar jmgilman avatar kukkok3 avatar manveru avatar minikin avatar mr-leshiy avatar mrzenioszeniou avatar mzabaluev avatar nicolasdp avatar nicopado avatar qnikst avatar rinor avatar saibatizoku avatar stevenj avatar vincenthz avatar zeegomo 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.