crystal-docs-web

master branch1 version

master branchlatestOct 1, 2016

github.com/barisbalic/crystal-docs-web

The code for the crystal-docs.org website.

7 stars

0 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  crystal-docs-web:
    github: barisbalic/crystal-docs-web
    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: Baris Balic <leafybasil@gmail.com>

Dependencies

Runtime Dependencies

kemal*github: sdogruyol/kemal, branch: master

README

# crystal-docs-web

Code for the [crystal-docs.org](https://crystal-docs.org) website.

Requires [crystal-lang](https://crystal-lang.org) 0.18.7+

You will need to create a GitHub developer application in order to test user interaction.

When starting the application you will need to provide the following environment variables:

- `GITHUB_CLIENT_ID`
- `GITHUB_CLIENT_SECRET`
- `CRYSTALDOCS_BASE_URL` which is used to generate the `redirect_uri` for the OAuth flow, making it easier to test locally.

Build with `crystal build --release src/crystal-docs-web.cr`.

## Contributing

1. Fork it ( https://github.com/barisbalic/crystal-docs-web/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

- [[barisbalic]](https://github.com/barisbalic) Baris Balic - creator, maintainer

crystal-docs-web

Installation

shard.yml

Dependencies

Runtime Dependencies

README

Documentation

Links

This branch

Dependents

Repository

Metadata