combine

1.4.620 versions

github.com/reload/combine

Fetch data from HarvestApp and expose an API for it. Successor to Harvester

0 stars

0 dependents

License: UNLICENSED

Installation

# Add this to your shard.yml
dependencies:
  combine:
    github: reload/combine
    version: ~> 1.4.6

Then run:

shards install

shard.yml

Crystal

1.13.1

License

UNLICENSED

Author

Thomas Fini Hansen

Targets

amber from lib/amber/src/amber/cli.cr
combine from src/combine.cr

Dependencies

Runtime Dependencies

amber1.4.1github: amberframework/amber
raven*github: Sija/raven.cr
granite~> 0.23.1github: amberframework/granite
harvest~> 0.2github: xendk/harvest.cr
sqlite3~> 0.19.0github: crystal-lang/crystal-sqlite3
multi_auth*github: msa7/multi_auth
citrine-i18n~> 1.0.0github: dare892/citrine-i18n
quartz_mailer~> 0.8.0github: amberframework/quartz-mailer
cron_scheduler*github: kostya/cron_scheduler
jasper_helpers~> 1.2.2github: amberframework/jasper-helpers

Development Dependencies

ameba~> 1.5.0github: crystal-ameba/amebadev

README

Combine (harvester)

This is a project written using Amber. Enjoy!

Getting Started

These instructions will get a copy of this project running on your machine for development and testing purposes.

Prerequisites

This project requires Crystal (installation guide).

Alternatively, docker compose up should bring up a container based setup (untested).

Initial setup

The environment configuration files are encrypted in git, so to run the project you'll need the key from 1Password:

op read op://Shared/rasikyplntusmmbszukvobmjz4/password >.encryption_key

Google Auth

To create Google OAuth credentials for single signon, go to Google Cloud Console and create a project for the app. Visit "Credentials" in the "APIs & Services" product, and create an OAuth client ID. The /signin/callback URL of your Combine instance should be added to "Authorized redirect URIs", and the "People API" should be enabled for the project.

Changelog

The changelog records the latest changes.

Development

To start your Amber server:

Install dependencies with shards install
Build executables with shards build
Create and migrate your database with bin/amber db create migrate.
Start Amber server with bin/amber watch

Now you can visit http://localhost:3000/ from your browser.

Tests

To run the test suite:

crystal spec

Contributing

Fork it ( https://github.com/reload/combine/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

Contributors

xendk Thomas Fini Hansen - creator, maintainer