Giter VIP home page Giter VIP logo

shardbox-core's Introduction

shardbox-core

Shards database, collecting shard repositories, releases and dependencies.

Installation

Prerequisites

  • Crystal (1.0.0 or later)
  • PostgreSQL database (version 12)
  • dbmate for database migrations

Database

PostgreSQL databases needs to be created manually.

Connection configuration is read from environment variables.

  • development database: DATABASE_URL
  • testing database: TEST_DATABASE_URL (only for running tests)

Install database schema:

  • make db - development database
  • make test_db - test database

Shard Dependencies

Run shards install to install dependencies.

Usage

Run make bin/worker to build the worker executable.

  • bin/worker import_catalog https://github.com/shardbox/catalog: Reads catalog description from the catalog repository and imports shards to the database.
  • bin/worker sync_repos: Synchronizes data from git repositories to database for all repositories not synced in the last 24 hours or never synced at all. Recommended to be run every hour.
  • bin/worker updated_metrics: Updates shard metrics in the database. Should be run once per day.
  • bin/worker loop starts a worker loop which schedules regular sync_repos and update_metrics jobs. It also listens to notifications sent through PostgreSQL notify channels in order to trigger catalog import.

A web application for browsing the database is available at https://github.com/shardbox/shardbox-web

Development

Run make test to execute the spec suite.

Contributing

  1. Fork it (https://github.com/shardbox/shardbox-web/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

shardbox-core's People

Contributors

jkthorne avatar straight-shoota avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

shardbox-core'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.