https://github.com/crystal-community/crystal-ann
Web site to announce new Crystal projects, blog posts, updates and other work activities
https://github.com/crystal-community/crystal-ann
amber-framework announcements crystal
Last synced: 11 months ago
JSON representation
Web site to announce new Crystal projects, blog posts, updates and other work activities
- Host: GitHub
- URL: https://github.com/crystal-community/crystal-ann
- Owner: crystal-community
- License: mit
- Created: 2017-07-09T17:00:13.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T07:29:36.000Z (over 3 years ago)
- Last Synced: 2024-11-30T01:44:51.825Z (over 1 year ago)
- Topics: amber-framework, announcements, crystal
- Language: CSS
- Homepage: https://crystal-ann.com
- Size: 1.18 MB
- Stars: 45
- Watchers: 9
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-opensource-apps - Crystal ANN - lang.org/) projects, blog posts, updates and other work activities | [https://crystal-ann.com](https://crystal-ann.com) | (Amber)
- awesome-opensource-apps - Crystal ANN - lang.org/) projects, blog posts, updates and other work activities | [https://crystal-ann.com](https://crystal-ann.com) | (Amber)
- awesome-hacktoberfest - crystal-ann - An awesome announcement tool for the Crystal programming language community. (Projects friendly to Hacktoberfest 1st time contributors / CSS)
README
# Crystal [ANN]
[](https://github.com/crystal-community/crystal-ann)
[](http://www.amberframework.org/)
[](https://twitter.com/crystallang_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](https://crystal-lang.org/docs/installation/index.html)
2. [Install Amber Framework](https://docs.amberframework.org/amber/getting-started)
3. [Install Postgres](http://postgresguide.com/setup/install.html)
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
``` sh
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](https://github.com/veelenga) V. Elenhaupt - creator, maintainer
* [hugoabonizio](https://github.com/hugoabonizio) Hugo Abonizio - contributor, maintainer
* [janczer](https://github.com/janczer) Janczer - contributor
* [lex111](https://github.com/lex111) Alexey Pyltsyn - contributor
* [vaibhavsingh97](https://github.com/vaibhavsingh97) Vaibhav Singh - contributor
* [PAPERPANKS](https://github.com/PAPERPANKS) Pankaj Kumar Gautam - contributor