Skip to content
A collection of companies, agencies, investors, and events showcasing the Montreal tech community.
HTML CSS JavaScript Ruby
Latest commit 007114a Mar 30, 2016 @lukechesser Merge pull request #27 from pwat92/master
add sharethebus
Failed to load latest commit information.
_assets
_data
_icons
_img
_js
_less
_plugins
_site
webfonts
.gitignore
Gemfile
Gemfile.lock
GruntFile.js
README.md
_config.yml
apple-touch-icon-114x114-precomposed.png
apple-touch-icon-144x144-precomposed.png
apple-touch-icon-72x72-precomposed.png
apple-touch-icon-precomposed.png
favicon.ico
favicon.png
favicon@2x.png
index.html
package.json
s3_website.yml

README.md

Montreal Collective

Codeship Status for lukechesser/Montreal-Collective

A collection of Montreal's best tech companies, startups, agencies, investors, and events.

Everything for the site is available to be modified here. To submit a company/agency/startup/investor, fork the repo and submit a pull-request with the changes. Same deal for making any changes to existing entries.

Most other 'Made by X' sites suffer from a lack of maintenance, because their creators register the domain name, throw up a quick site, quickly lose interest/become overwhelmed by the constant churn of startups, causing the site to become outdated and unmaintained. Since everything for this site is hosted on GitHub in flat files, and the site is hosted on AWS, this should make the project easy to maintain and update. So instead of a flood of emails for me and a shitty outdated website for you, we'll be modern and try this out.

How to add a company

To add your entry, follow the steps for forking the repo and creating a pull-request and update the _data/entries.yml file with your entry's information. The mandatory information to include is:

- name: Entry Name
  category: company | agency | investor | event
  url: www.name.com
  description: Some nice description about the entry. Preferrably between 125-175 characters. Like a long tweet.

Optionally, you can add:

- ...
  ...
  twitter: entryname
  facebook: entryname

Save your entry at the bottom of the file (use spaces for the indentation, not tabs — YAML doesn't like tabs). Note a couple of guidelines (also see the existing entries for a better idea of what to write):

  1. name: Don't name it 'Montreal blah blah'. That's assumed already. So if it's the 'Montreal' chapter of 'Startup Festival', call it Startup Festival.

  2. category: Use singular categories (event instead of events). Only list each entry as one, otherwise you might break something.

  3. url: Don't put in the https:// or http://. Preferably, don't put in the /en or /fr either (if it's a bilingual site) — just link to the root domain since it will likely be the more popular version. Leave off the trailing / if your website supports it (it looks prettier without the slash <3).

  4. description: Ease off the marketing lingo and definitely leave off the investor speak (ie there better not be any appearences of 'digital solution' or 'synergy' anywhere in your description). Use the third-person narrative preferrably (ie. don't say 'Shopify is the best platform for YOU to build an online store').

  5. twitter (optional): leave off the @. Preferrably all lowercase.

  6. facebook (optional): preferrably all lowercase.

As for the image/logo, fire up Photoshop and download this template PSD. If you turn on the guidelines, make sure your logo fits inside the inner guidelines and is roughly centered. Preferrably, use a background color other than white (it makes your company standout more and looks less boring). Save the image as a JPEG (high-quality is fine, because it gets run through a minimizer before deploying anyways). Put the logo in the _img directory, not the img directory.

Commit and push. Then open up a pull-request. If the pull-reqest is approved, it will be merged and automatically pushed to the site via a build process on Codeship.

Lastly, it would be great if you linked to the site somewhere on your own website (ex. a link in your site's footer linking 'Made in Montreal' to this site).

If this all sounds too technical, feel free to create an issue with the same information (logo, name, description, etc.) and one of the maintainers will add it in when they get time.

Editing existing entries

Same deal as adding a new entry: fork and create a pull-request. Only this time half the work is already done for you. Note that changes can be made by anyone, but preference will be given for employees/volunteers of the company/agency/event/investor.

Contributing

To setup the environment locally, clone the repo and from the command line:

  1. Install jekyll globally with gem install jekyll.

If you're only editing the _data/entries.yml file, the only command you need is jekyll serve, which will build the static site and serve the file at http://0.0.0.0:3000.

If you want to do more than just edit the _data/entries.yml file, you'll also have to install Grunt and its dependencies:

  1. Install grunt-cli globally with npm install -g grunt-cli.
  2. Navigate to the root /montreal-collective directory, then run npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.

When completed, you'll be able to run the various Grunt commands provided from the command line (look in the GruntFile.js for the additional commands).

Unfamiliar with npm? Don't have node installed? That's okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.

Contributors

License

Copyright (c) 2013 Luke Chesser

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.