latentflip / hr-til

Today I Learned

HR-TIL

TIL is a project by Hashrocket to catalogue the sharing & accumulation of knowledge as it happens day-to-day. Posts have a 200-word limit and any Hashrocket team member can contribute.

This site was open sourced as a window into our development process, as well as to allow people to experiment with the site on their own and contribute the project.

Install

If you are creating your own version of the site, fork the repository. Then, follow these setup steps:

$ git clone https://github.com/hashrocket/hr-til
$ cd hr-til
$ bundle install
$ rake db:setup
$ cp config/application.yml{,.example}
$ rails s

Authentication is managed by Omniauth and Google. To whitelist a domain or multiple domains, add the domain name to your environmental variables:

# config/application.yml

permitted_domains: 'hashrocket.com|hshrckt.com'

With this in place, you can visit '/admin' and log in with an email address from the domain you've allowed.

Dependencies

The selenium-webdriver gem requires the Firefox browser.

Hosting

Staging and production for Hashrocket's TIL is located here:

• http://hr-til-staging.herokuapp.com
• https://til.hashrocket.com

Environmental Variables

basic_auth_credentials toggles basic authentication:

# config/application.yml

basic_auth_credentials: username:password

slack_post_endpoint configures Slack integration:

# config/application.yml

slack_post_endpoint: /services/some/hashes

Contributing

We welcome contributions and feedback! Please open an issue or submit a pull request if you have something to add.

License

TIL is released under the MIT License.