We unfortunately don't have time to support issues, fixes, or pull requests for this repository. This code was posted as is, in hopes it would be useful to others in the community.
Originally open sourced over on our engineering blog, and discussed in great detail over at Tim Ferriss' Blog, Prelaunchr is a skeleton Rails application for quickly starting a viral prelaunch campaign for new companies or products. The campaign is conducive to social sharing and has prize levels based on the number of people each person refers. By default, we've included our original HTML/CSS for both the site and email to give you a better idea of how this looked when actually running.
Prelaunchr has a main mechanic from which everything else is derived: Every User
is given a unique referral_code
which is how the application knows who referred a signing up user. Based on the amount of referrals a User
has brought to the site, they are put into a different "prize group". The groups, amounts, and prizes are completely up to you to set.
By default, we block more than 2 sign-ups from the same IP address. This was simplistic, but was good enough for us during our campaign. If you want something more substantial take a look at Rack::Attack
Get Ruby 2.2.0 (rbenv), bundle and install:
brew update && brew upgrade ruby-build && rbenv install 2.2.0
Clone the repo and enter the folder (commands not shown).
Install Bundler, Foreman and Mailcatcher then Bundle:
gem install bundler foreman mailcatcher
bundle
Copy the local database.yml
file sample and .env.sample
:
cp config/database.yml.sample config/database.yml
cp .env.sample .env
Setup your local database:
bundle exec rake db:create
bundle exec rake db:migrate
Start local server and mail worker:
foreman start
<<<<<<< HEAD
View your website at the port default http://localhost:5000/
.
View sent mails at http://localhost:1080/
.
In Rails console, run this command. Be careful to not use the example admin user for security reasons. Password confirmation should match password.
AdminUser.create!(:email => 'admin@example.com', :password => 'password', :password_confirmation => 'passwordconfirmaiton')
You can run this locally in a Rails console for development testing.
View your website at the port default http://localhost:7000/
.
View sent mails at http://localhost:1080/
.
0b07c7c... Add information on viewing emails in development
In Rails console, run this command. Be careful to not use the example admin user for security reasons. Password confirmation should match password.
AdminUser.create!(:email => 'admin@example.com', :password => 'password', :password_confirmation => 'passwordconfirmaiton')
You can run this locally in a Rails console for development testing.
If you are deployed to Heroku, you would run it there.
When your prelaunch campaign comes to an end we've included a helpful rake
task to help you compile the list of winners into CSV's containing the email addresses and the amount of referrals the user had.
- Run
bundle exec rake prelaunchr:create_winner_csvs
and the app will export CSV's in/lib/assets
corresponding to each prize group.
- Set the different prize levels on the
User::REFERRAL_STEPS
constant inside/app/models/user.rb
- The
config.ended
setting in/config/application.rb
decides whether the prelaunch campaign has ended or not (e.g. Active/Inactive). We've included this option so you can quickly close the application and direct users to your newly launched site.
The code, documentation, non-branded copy and configuration are released under the MIT license. Any branded assets are included only to illustrate and inspire.
Please change the artwork to use your own brand! Harry's does not give you permission to use our brand or trademarks in your own marketing.