Ruby HTML CSS CoffeeScript JavaScript
Latest commit a5dcae9 Jan 31, 2017 @sophiedeziel sophiedeziel committed on GitHub Em77 implement joblint (#247)
* Add missing ')' causing error on jobs/show page

* Begin adding joblint results to job show page within administrate. Add working count/graph for joblint 'issue' categories.

* Add working issue descriptions to joblint results

* Add styling to joblint results

* Add padding to joblint issue descriptions

* Move color literals into variables, change order of style properties.

* remove administrate assets

* remove administrate javascripts

* add empty line to separate variable declaration and rules

* Change if statement to guard clause
Permalink
Failed to load latest commit information.
app Em77 implement joblint (#247) Jan 31, 2017
bin Rubocop: fix offenses which could be fixed automagically Dec 11, 2015
config Em77 implement joblint (#247) Jan 31, 2017
db use sqlite3 for development (#245) Dec 21, 2016
lib Fix #115 - add 'user_id' to 3 models: Event, Job, NewsItem Mar 5, 2016
log Empty Rails 4 App + Home Controller Sep 29, 2014
public Added Emoji Support πŸ‘ πŸ”₯ πŸ‘ #225 (#226) Nov 23, 2016
spec run rubocop -a Nov 23, 2016
vendor/assets Em77 implement joblint (#247) Jan 31, 2017
.coffeescript-style.json [chore] Fixes #92 - Setup houndci.com Dec 3, 2015
.env.sample closes #207 Apr 29, 2016
.gitignore Added Emoji Support πŸ‘ πŸ”₯ πŸ‘ #225 (#226) Nov 23, 2016
.hound.yml [chore] Fixes #92 - Setup houndci.com Dec 3, 2015
.rspec Use bin/rspec in Guardfile Nov 8, 2015
.rubocop.yml [chore] Fixes #131 - code styling rule to be enforced Dec 12, 2015
.ruby-style.yml Update linting to match houndci.com's Mar 4, 2016
.ruby-version update ruby version and gems May 17, 2016
.scss-style.yml [chore] Fixes #92 - Setup houndci.com Dec 3, 2015
.travis.yml update .travis.yml to build May 17, 2016
CODE_OF_CONDUCT.md Fix #49 - Beef-up the CONTRIBUTING.md content Nov 21, 2015
CONTRIBUTING.md Revert "improving the chances of having a pull request accepted" Jan 20, 2016
Gemfile run rubocop -a Nov 23, 2016
Gemfile.lock updated gems Nov 23, 2016
Guardfile run rubocop -a Nov 23, 2016
LICENSE Fix #44 - Update MIT License Nov 21, 2015
Procfile More preparation for Heroku (unicorn + procfile) Sep 29, 2014
README.md use sqlite3 for development (#245) Dec 21, 2016
Rakefile run rubocop -a Nov 23, 2016
TODO.md A better Readme file for an open-source repository Nov 4, 2015
config.ru run rubocop -a Nov 23, 2016

README.md

Montreal.rb website

Build Status Dependency Status Code Climate Coverage Status Stories in Priority

Description

This is the Montreal.rb organization's website. It is still in development stage so you are welcome to contribute. You can join our Slack Team if you have any question, need some help to get started or just hang around with friendly people.

Want to contribute? First thing to look at are the Issues with the priority label. You can optionnally use Waffle.io to see the development pipeline used to manage the project.

Throughput Graph

Requirements

Runtime

  • ruby 2.3.1
  • Postgresql 9.3+

Development Setup

Fork the repository and clone it to your machine. Then change directory to Montreal.rb

$ git clone <your_fork> && cd Montreal.rb

Ruby & Bundler

You should have Ruby version 2.3.1 installed using your prefered Ruby version management tool (or by globally updating your system Ruby)

Most Popular Ruby Version Managers

You should also have bundler (minimum v1.10) to help with tracking and installing the exact gems and versions that are needed.

Database

For development, sqlite3 will be used.

Rails

You should check out Ruby on Rails' guides if you are not familiar with the framework : http://guides.rubyonrails.org/

Setup your Project

$ bin/setup

Once successfully completed, this setup script will:

  • install bundler for managing your gem dependencies
  • install your project's required gems
  • create and setup your database
  • cleanup logs and temporary files

Set environment variables

Omniauth is used to allow users to log in to the site using GitHub accounts. To use the GitHub API, you must set environment variables for the GitHub 'key' and 'secret.'

You can first obtain this key/secret through your GitHub account.

For image hosting Cloudinary is used. This service gives us the ability to host images with a heroku app. Sign up for a free coludinary account.

To tweet automatically when content is published, you can register an app on Twitter and set the keys to your environment variables. If you choose not to, don't set the variables and the app will simply skip the tweeting feature.

Now you need to set the environment variables on your server. The procedure will depend on your system.

For development, copy .env.sample file to .env and fill appropriately the variables settings.

If using Heroku, you can set the environment variables like this:

heroku config:add GITHUB_KEY=your_key GITHUB_SECRET=your_secret \
  CLOUDINARY_URL=cloudinary://your_key:your_secret \
  --app Montreal.rb

Start your Web Server

You should be ready to start your webserver using:

$ bin/rails server

By default, your application is accessible at http://localhost:3000 in your browser.

Testing

RSpec is used to test the application. You can run all the tests using

$ bin/rspec

or you can run a specific test file (example 1), or a single test (example 2, 17 is the line number of your test)

$ bin/rspec spec/path/to/your/file.rb    # example 1

$ bin/rspec spec/path/to/your/file.rb:17 # example 2

You can also use guard to test automatically when you save a file

$ bundle exec guard

PROTIP: install ctags and guard will automatically generate an index (or tag) file of language objects found in source files that allows these items to be quickly and easily located by a text editor.

  • ex: macos brew install ctags && sudo mv /usr/bin/ctags /usr/bin/ctags.bak
  • ex: ubuntu sudo apt-get install exuberant-ctags

Deploy

This application is automatically deployed to heroku after a successful Travis CI build of the master branch.

URLs

Bug Tracker

If you find any bug, please open an issue in the project's Github repository (https://github.com/montrealrb/Montreal.rb/issues)

Contributing

Please see CONTRIBUTING.md.

Everyone interacting in Montrealrb.com and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow our code of conduct.

License

montrealrb.com is released under the MIT License.