https://github.com/hashrocket/hr-til
Today I Learned in Ruby
https://github.com/hashrocket/hr-til
Last synced: 6 months ago
JSON representation
Today I Learned in Ruby
- Host: GitHub
- URL: https://github.com/hashrocket/hr-til
- Owner: hashrocket
- Archived: true
- Created: 2015-03-16T21:39:52.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-04-09T16:49:54.000Z (about 8 years ago)
- Last Synced: 2024-07-18T20:41:32.260Z (almost 2 years ago)
- Language: Ruby
- Homepage:
- Size: 3.95 MB
- Stars: 341
- Watchers: 29
- Forks: 71
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# HR-TIL
> TIL is an open-source project by the team at
> [Hashrocket](https://hashrocket.com/) that catalogues the sharing &
> accumulation of knowledge as it happens day-to-day. Posts have a 200-word
> limit, and posting is open to any Rocketeer as well as select friends of the
> team. We hope you enjoy learning along with us.
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 to the
project.
Today I Learned was ported to Elixir/Phoenix in 2017 ([source
code](https://github.com/hashrocket/tilex)), and the Rails application is no
longer in production or actively maintained by Hashrocket. Thanks to all of our
[contributors](https://github.com/hashrocket/hr-til/graphs/contributors)!
### Install
If you are creating your own version of the site,
[fork](https://help.github.com/articles/fork-a-repo/) the repository.
Then, follow these setup steps:
```sh
$ git clone https://github.com/hashrocket/hr-til
$ cd hr-til
$ gem install bundler
$ bundle install
$ cp config/application.yml{.example,}
$ rake db:create db:migrate db:seed
$ rails s
```
In development, `db:seed` will load sample data for channels, developers, and
posts. Omit this command to opt-out of this step, or create your own sample
data in `db/seeds/development.rb`.
Authentication is managed by Omniauth and Google. See the
[omniauth-google-oauth2
README](https://github.com/zquestz/omniauth-google-oauth2/blob/master/README.md)
and [Google Oauth 2
docs](https://developers.google.com/identity/protocols/OAuth2WebServer) for
setup instructions. To allow users from a domain, multiple domains, or a
specific email to log in, set those configurations in your environmental
variables:
```yml
# config/application.yml
permitted_domains: 'hashrocket.com|hshrckt.com'
permitted_emails: 'friend@whitelist.com'
```
Ensure you have set the google client id and google client secret via Oauth instructions.
Once set, visit '/admin' and log in with a permitted email address or domain.
### Testing
Run all tests with:
```
$ rake
```
Or, run all the test in parallel with [flatware](https://github.com/briandunn/flatware):
```
$ flatware fan rake db:test:prepare
$ flatware rspec && flatware cucumber
```
### Dependencies
- The gem `selenium-webdriver` depends on the Firefox browser.
- The gems `flatware-rspec` and `flatware-cucumber` require ZeroMQ. Learn more
[here](https://github.com/briandunn/flatware).
### Environmental Variables
`basic_auth_credentials` both toggles and defines basic authentication:
```yml
# config/application.yml
basic_auth_credentials: username:password
```
`slack_post_endpoint` allows the app to post to [Slack](https://slack.com/):
```yml
# config/application.yml
slack_post_endpoint: /services/some/hashes
```
### Contributing
1. [Fork](https://help.github.com/articles/fork-a-repo/) it
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 new Pull Request
Bug reports and pull requests are welcome on GitHub at
https://github.com/hashrocket/hr-til. This project is intended to be a safe,
welcoming space for collaboration, and contributors are expected to adhere to
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
### Usage
We love seeing forks of Today I Learned in production! Please consult our
[usage guide](/USAGE.md) for guidelines on appropriate styling and attribution.
### License
TIL is released under the [MIT License](http://www.opensource.org/licenses/MIT).
---
### About
[](https://hashrocket.com)
TIL is supported by the team at [Hashrocket, a
multidisciplinary design and development consultancy](https://hashrocket.com). If you'd like to [work with
us](https://hashrocket.com/contact-us/hire-us) or [join our
team](https://hashrocket.com/contact-us/jobs), don't hesitate to get in touch.