Read Me

This is the website for Les Pitonneux. It's still in development and everyone is welcome to contribute! The public-facing part shows our upcoming events and behind the scenes it allows for organizers to manage and plan events. Everybody is welcome and encouraged to contribute. This can be a great way to get your feet wet with contributing to a live open-source project! Feel free to come out to our meetups if you have any questions, need some help getting started, or just want to meet some friendly people.

Contributing

We love contributions! The first thing to check are the Issues with the priority label. You can also optionally use Zenhub to see the development pipeline and issue boards and pick any issue from the "Next Up" column. When you start working on an issue, let everyone else know somehow (move the issue to the "In Progress" column, add the "in progress" label, or even just leave a comment saying "Got this one!"), so that we don't end up with two people developing the same feature at the same time.

Anybody is welcome to submit a pull request. See below on how to set up your machine for development. Once you have the app up and running, run the tests (rspec) and make sure they pass. Then write some specs and add your changes. Make the tests pass again. Then push to your fork and submit a pull request. Then, you'll be waiting on us. We try to at least comment on all pull requests within a couple of days. We might suggest some changes or improvements or alternatives. Some things you can do to increase the chances of your pull request being accepted are:

• Make sure everything is tested
• Follow the style and standards of the project
• Write a good commit message
• Discuss major features or changes before deciding on a final approach

Style Guides

This codebase is monitored by hound CI, which automatically comments on style violations. We follow community style guides for ruby, Rails, Sass, coffeescript, and slim. If your pull request has some comments by the hound, please fix those to speed up the review process.

Development Setup

Fork the repository and clone it to your machine then change directory into website. Rename it if you want to.

git clone [email protected]:***your-github-username***/Montreal.rb.git && cd website

Database

This project uses Postgresql, a free and open-source database. Google the instructions on how to install it for your operating system, or if you're on a mac run

brew install postgresql

Ruby version

The project currently uses ruby 2.3.1. You can install many versions of Ruby on your machine with a ruby environment manager. Two common ones are rbenv and rvm.

Libraries

External depenencies are managed with bundler. It will be installed when you run the bin/setup script, or if you're setting up your environment by yourself you can install it manually

gem install bundler

Rails

The project is built with Rails, a stable and mature web framework. If you're unfamiliar with it there are tons of great tutorials out there, like Michael Hartl's Rails tutorial, or you can check out the great documentation on RailsGuides.

Setup the project

Once you have the above dependencies installed, setup the project with

bin/setup

This script runs the following commands to set up your local development environment:

• install bundler for managing gem dependencies
• install all required gems
• create and setup your databse
• cleanup logs and temporary files

Setting environment variables

We use cloudinary for image hosting. You can sign up for a free cloudinary account to get API keys for local development and testing. You'll need to set the environment variables CLOUDINARY_API_KEY and CLOUDINARY_API_SECRET to use image uploading.

Starting your server

You can run a local server with

rails server

Unless you configure a different local host the app will be available at http://localhost:3000.

You'll also need to have a postgres server running. You can use an autolauncher or start the server manually. Run

brew info postgres

for the instructions on how to start postgresql.

Testing

The app is tested with RSpec. You can run all the tests with

rspec

Run a single test file by passing only the test file, or a single test example by passing the test file with the line of the test you want to run:

rspec spec/path/to/your/spec.rb
rspec spec/path/to/your/spec.rb:8  # 8 is the line number of the test you want to run.

I recommend using zeus, an external gem, to pre-load the app so your tests run instantly.

Bugs

If you find any bugs please open an issue in project's repo.

License

This app is released under the MIT License.