middleman

Version, currently master branch1 version
  • master branchlatestOct 19, 2016

github.com/ltran/middleman

URL Shortener written in Crystal

5 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  middleman:
    github: ltran/middleman
    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
no constraint declared
License
MIT
Author
Louis Tran

Dependencies

Runtime Dependencies

  • pg*github: will/crystal-pg
  • pool*github: ysbaddaden/pool
  • kemal*github: sdogruyol/kemal, branch: master
  • dotenv*github: gdotdesign/cr-dotenv
  • micrate*github: juanedi/micrate

README

Code Climate Test Coverage Issue Count

middleman

URL Shortener written in Crystal.

Installation

Optional:

$ curl -L https://raw.github.com/pine/crenv/master/install.sh | bash
$ echo 'export PATH="$HOME/.crenv/bin:$PATH"' >> ~/.bash_profile
$ echo 'eval "$(crenv init -)"' >> ~/.bash_profile
$ exec $SHELL -l
$ crenvn -v

Install Crystal Build

$ git clone https://github.com/pine/crystal-build.git ~/.crenv/plugins/crystal-build

Install Crystal by crenv

$ crenv install 0.19.0 # install Crystal
$ crenv global 0.19.0 # set global Crystal version
$ crenv rehash

$ crystal --version
Crystal 0.19.0 (2016-09-02)

$ shards --version
Shards 0.6.3 (2016-09-02)

Usage

Run without compiling

crystal ./src/middleman.cr

Compiling

crystal build ./src/middleman.cr
crystal build -d ./src/middleman.cr  # debug mode

Running Compiled Project

./middleman

Development

TODO: Write test.

Contributing

  1. Fork it ( https://github.com/ltran/middleman/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

  • [ltran] Louis Tran - creator, maintainer