Note: This project is out of date and should not be used as is.
This project exists because the pre-existing solutions such as rails-stripe-membership-saas and more for building a SaaS application simply didn't fit my needs. While those projects are fantastic and may cover a wider range of functionalities, I found myself fighting with the code rather than building and understanding it.
I tried to keep this project as simple, straightforward, and barebones as possible so that anyone who would like to use the code as a starting point for their projects would have very little code to confuse them and/or modify to their needs.
When it is finished, the application should support the following functionalities.
- User authentication/login via Devise and OmniAuth (Facebook and Twitter)
- Subscription billing handled by Stripe
- Also includes handling payment changes, and webhooks
- Bootstrap implementation for ease of design
This project is ongoing and may not have all of the above features.
For instructions on how to setup and use the code as a starter project, see installation below. Note that there are some dependencies that may make this project unsuitable for your uses and there are a lot of different ways to go about setting up this project that I will not be covering.
Provide code examples and explanations of how to get the project.
After cloning the repository to your computer start by running 'bundle install' and 'rails db:migrate'
Devise should work on its own out of the box, but if you would like to use social sign-ups you are going to have to set the environment variables and create apps within the developer sections of Facebook and Google.
First create your applications with Google and Facebook. Links provided below.
- https://developers.facebook.com/apps/
- https://console.developers.google.com/ (Make sure to use/activate Google Contacts and Google Plus)
After creating your applications with the above, set the environment variables to your API keys either remotely or locally.
To do so locally:
Run the below command in the shell:
- source ~/.bashrc
Add these lines to the file:
- export GOOGLE_APP_ID="some_api_key"
- export GOOGLE_APP_SECRET="some_api_key"
- export FB_APP_ID="some_api_key"
- export FB_APP_SECRET="some_api_key"
To do so in Heroku, simply run heroku set:config environment_variable=value where 'environment_variable' and 'value' correspond to the local lines.
- For more info, see : https://devcenter.heroku.com/articles/config-vars
Restart your terminal.
Then go into config/initializers/devise.rb and change "your_url.com" to your URL to make the callback URL work.
Add the callback URL in these files to your Google and Facebook applications. Google is somewhat picky about http/https options, so it is safer to add both and configure based on any errors shown.
Similarly to the above, sign up for a Stripe account and retrieve your API keys.
Set the environment variables in the same way as above for the variables 'stripe_publishable_key' and 'stripe_secret_key'.
The test keys are set up to be hard-coded in the application at config/secrets.yml.
By default your Stripe url for webhooks is set to http://your_url.com/stripe/webhooks . I handle webhooks in config/initializers/stripe.rb for the time-being.
Make sure to create plans in the Stripe dashboard and note their id's as you are going to have to pass them to the controller. This is currently handled in the devise/new controller/view. Set your plan name/s in the app/controller/application_controller.rb to direct the user to subscription or not based on whether the plan is free.
See the link here to learn how to setup SSL on your site for free:
This starter project simply combines existing technologies such as Twitter Bootstrap, Ruby on Rails, Devise & OmniAuth gems, Stripe, and more.
As a result, it is intended to be used simply as a starter template for SaaS projects using Rails and is licensed under the MIT license.
This project uses Ruby 2.3.0 with Rails 5.0