Crystal [ANN]

Notice

Crystal [ANN] is no longer maintained. Website was taken down as of March 2025.

The announcement data has been exported and preserved in the db/data folder:

• announcements.json.gz: JSON format of all announcements
• announcements.sql.gz: SQL dump of the announcements table

This repository remains available for historical reference and educational purposes.

Setup

1. Install Crystal
2. Install Amber Framework
3. Install Postgres
4. Create crystal_ann and crystal_ann_test pg databases

Development

1. Install project dependencies:

$ shards install

2. Run database migrations:

$ amber db migrate

3. Seed data:

$ amber db seed

4. Start app and watch for source changes:

$ amber w

Testing

Migrate test database and run specs:

$ MICRATE_RUN_UP=true crystal spec

Docker

Run the app using docker-compose

docker-compose up

Deployment to Heroku

$ heroku create app-name --buildpack https://github.com/crystal-lang/heroku-buildpack-crystal.git
$ heroku buildpacks:add https://github.com/veelenga/heroku-buildpack-sidekiq.cr
$ git push heroku master

And set environment variables with heroku config:set VAR=VAL:

AMBER_ENV
AMBER_SESSION_SECRET

MICRATE_RUN_UP
REDIS_PROVIDER

GITHUB_ID
GITHUB_SECRET

TWITTER_CONSUMER_KEY
TWITTER_CONSUMER_SECRET
TWITTER_ACCESS_TOKEN
TWITTER_ACCESS_TOKEN_SECRET

TWITTER_OAUTH_CONSUMER_KEY
TWITTER_OAUTH_CONSUMER_SECRET

Contributors

• veelenga V. Elenhaupt - creator, maintainer
• hugoabonizio Hugo Abonizio - contributor, maintainer
• janczer Janczer - contributor
• lex111 Alexey Pyltsyn - contributor
• vaibhavsingh97 Vaibhav Singh - contributor
• PAPERPANKS Pankaj Kumar Gautam - contributor