today-we-learned

Version, currently master branch1 version
  • master branchlatestFeb 2, 2018

github.com/ChangJoo-Park/today-we-learned

WIP : Social today i learned

4 stars
0 dependents
License: UNLICENSED

Installation

# Add this to your shard.yml
dependencies:
  today-we-learned:
    github: ChangJoo-Park/today-we-learned
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.24.1
License
UNLICENSED
Author
ChangJoo Park
Target
  • today-we-learned from src/today-we-learned.cr

Dependencies

Runtime Dependencies

  • pg~> 0.14.1github: will/crystal-pg
  • amber0.6.4github: amberframework/amber
  • autolink*github: crystal-community/autolink.cr
  • gravatarcr*github: changjoo-park/gravatarcr
  • granite_orm~> 0.8.2github: amberframework/granite-orm
  • quartz_mailer~> 0.4.0github: amberframework/quartz-mailer
  • jasper_helpers~> 0.1.6github: amberframework/jasper-helpers

Development Dependencies

  • garnet_spec~> 0.1.1github: amberframework/garnet-specdev

README

TODAY WE LEARNED

TWL

TODAY WE LEARNED is a new project using Amber Framework

Installation

Install shard dependencies.

shards install

Configure the config/environments/development.yml and set the database_url with your credentials to your database.

Then:

amber db create migrate

Usage

Development

To run amber development server:

amber watch

Production

To setup AMBER_ENV:

export AMBER_ENV=production

To build a production release:

shards build --production --release today-we-learned

To build production assets:

npm run release

To use encrypted environment settings see documentation

Docker Compose

This will start an instance of postgres, migrate the database, and launch the site at http://localhost:3000

docker-compose up -d

To view the logs:

docker-compose logs -f

Note: The Docker images are compatible with Heroku.

Contributing

  1. Fork it ( https://github.com/changjoo-park/today-we-learned/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