Skip to content

ronaldocpontes/Crowdhoster

 
 

Repository files navigation

Crowdhoster

Crowdhoster index

"Launch your own crowdfunding site...without touching a line of code"

Well, if you're here, maybe you want to touch some of the code.


Quick Links:

"I want to launch my own campaign without touching any code." - Head to the main Crowdhoster page.
"I want help customizing my Crowdhoster page." - Check out this Crowdhoster setup guide.
"I want to contact the Crowdhoster team." - Email us directly: [email protected]

Install

Dependencies

To run Crowdhoster you'll need the following prerequisites installed:

  • Homebrew (for downloading software packages)
$ ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
  • Git (version control)
$ brew install git
  • RVM, ruby 1.9.3, and the Rails gem
$ \curl -L https://get.rvm.io | bash -s stable --rails --ruby=1.9.3
$ rvm use 1.9.3 --default
$ brew install imagemagick

Service Providers

To run Crowdhoster you'll also need to complete the following:

  • Sign up for a Balanced account (test marketplace and live marketplace)
  • Sign up for the Crowdtilt API - Email [[email protected]](mailto:[email protected]?subject=API Key Request for Crowdhoster&body=Hi! I'd like to deploy a Crowdhoster app. The Github readme sent me here to ask for an API key. Thanks!) to get your API keys
  • Sign up for AWS (free) and set up a bucket for your assets
  • Sign up for Mailgun (free)

Local Setup

Clone the Crowdhoster repo into a new directory

$ git clone https://github.com/Crowdtilt/Crowdhoster {DIRECTORY}

Switch to the newly created project directory

$ cd {DIRECTORY}

Create a .env file in the project root…easiest way is to create a copy of the .env.example file

$ cp .env.example .env

Then open up the .env file and fill in the variables with your app_name and credentials. Leave "ENABLE_ASSET_SYNC" set to 'true' if you plan to use AWS to host your assets (recommended):

APP_NAME=myawesomeapp
CROWDTILT_SANDBOX_KEY=crowdtiltsandboxkey
CROWDTILT_SANDBOX_SECRET=crowdtiltsandboxsecret
CROWDTILT_PRODUCTION_KEY=crowdtiltproductionkey
CROWDTILT_PRODUCTION_SECRET=crowdtiltproductionsecret
ENABLE_ASSET_SYNC=true
AWS_BUCKET=awsbucket
AWS_ACCESS_KEY_ID=awsaccesskey
AWS_SECRET_ACCESS_KEY=awssecretaccesskey
MAILGUN_DOMAIN=myawesomeapp.mailgun.org
MAILGUN_PASSWORD=mailgunpassword
[email protected]

Install the gems

$ bundle install

Create and migrate the DB

$ foreman run rake db:create
$ foreman run rake db:migrate

Start the server

$ foreman start

Run the console

$ foreman run rails c

Deploying to Heroku

  1. Sign up for a Heroku Account
  2. Install the Heroku Toolbelt

Create a new Heroku app

$ heroku create {APP NAME}

Enable the use of environment variables during asset precompiling

$ heroku labs:enable user-env-compile

Install the Heroku config plugin if you don't already have it installed

$ heroku plugins:install git://github.com/ddollar/heroku-config.git

Push the configuration to Heroku

$ heroku config:push 

Deploy the code to Heroku

$ git push heroku master

Migrate the database

$ heroku run rake db:migrate

Launch the app!

$ heroku open

Contribute

Looking to help make Crowdhoster better?

Our feature development roadmap and bugs are inputted as issues.

See a complete list by clicking here.

Contact and License

Want to get in touch? Email [email protected].

MIT License. Copyright 2013 Crowdtilt.

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.


Brought to you by the team at Crowdtilt // Group fund anything

About

Open source crowdfunding platform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published