Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 4.06 KB

README.md

File metadata and controls

70 lines (47 loc) · 4.06 KB
Raw

##Welcome to the CodeMontage Platform Build Status

CodeMontage empowers coders to improve their impact on the world.

We believe coding can help save the world. With this platform, we aim to help coders everywhere find and contribute to open source projects that improve the world and make us better coders.

Join our mission to create superhero coders! You can get involved by taking any of the following actions:

  1. Register for CodeMontage.
  2. Follow us on Twitter.
  3. Be the change you wish to see by creating a branch submitting a pull request to improve the platform. Please include a screenshot of any user interface changes with all pull requests.
  4. Suggest an improvement by opening an issue. Please follow our issue template and use multiple emojis for maximum effectiveness. 👍💯😉
  5. Reach out to us at [email protected].

###Development Environment Setup

These setup instructions have been tested on Mac OS X, Microsoft Windows 7 with and without Cygwin, and Linux (Ubuntu 10.8.) Installing and running the site under Windows with or without Cygwin may be possible with enough environmental modifications, but doing so is outside the scope of this document.

CodeMontage currently uses Ruby on Rails 3.2.17 and Postgres 9.2.2. The Gemfile specifies Ruby 2.1.5, but the site also runs in development under 1.9.3 and 2.1.1 (tested in Ubuntu.)

To get started,

  • Install Rails. If you're using a Mac, we recommend Rails Installer. Under Ubuntu, follow the instructions here.

  • Install Postgres. For the Mac, we recommend Postgres App. (If you're using Mac OS X Lion, you may need this fix for Postgres.) Under Ubuntu, follow the instructions here.

  • Clone the CodeMontage Repo: git clone https://github.com/CodeMontageHQ/codemontage.git

  • Install dependencies:

    cd codemontage
bundle install

  • Configure the app for your local database by copying database.yml.sample to database.yml and adding a valid username and password. Make any changes needed for your database setup ( and possibly rake db:create). cp config/database.yml.sample config/database.yml

  • Create database: rake db:create

  • Run migrations: rake db:migrate

  • Load helpful example data into your local database: rake db:seed

  • If you'll be developing GitHub-related functionality, register a GitHub API Application using Homepage URL http://localhost:3000 and Authorization callback URL http://localhost:3000/auth/github/callback. Next, set your GitHub-related environment variables in a file called .env:

    GITHUB_KEY=client_id
GITHUB_SECRET=client_secret

    You can find the Client ID and Client Secret for your application from the Applications page.

  • If you don't have a JavaScript runtime installed, install nodejs:

    Linux sudo apt-get install nodejs

    Mac brew install nodejs

  • Once you've installed these dependencies, test your setup by running rails server and visiting your site at http://localhost:3000

Congratulations, you're ready to help build CodeMontage!

License

Copyright (c) 2014 Code for Humanity, LLC. See LICENSE for details.