Shards database, collecting shard repositories, releases and dependencies.
- Crystal (1.0.0 or later)
- PostgreSQL database (version 12)
- dbmate for database migrations
PostgreSQL databases needs to be created manually.
Connection configuration is read from environment variables.
- development database:
- testing database:
TEST_DATABASE_URL(only for running tests)
Install database schema:
make db- development database
make test_db- test database
shards install to install dependencies.
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 loopstarts a worker loop which schedules regular
update_metricsjobs. 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
make test to execute the spec suite.
- Fork it (https://github.com/shardbox/shardbox-web/fork)
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
- Johannes Müller - creator and maintainer