saaskit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67cfe02cb43217ecf7a4e4d61308281315fb79b34a609466e8ab6c47807503f5
+  data.tar.gz: bf608859e3c553a5132ba5f1290a4d82cad03feaf4b430e09d1e9fd3ff117c6f
+SHA512:
+  metadata.gz: 9a85bfb372a42f587fbe9be2a06016ca6629c98a4250b5570c014ffa3df346ae2f1726311dbd59eb9d7a303bfb04b600aa3f7dc32914f87e7876f184c20ba157
+  data.tar.gz: 48dc7351b5c79ad8731e8981a7ff2b2c2b4a20ca9732ed1363cbcb7414c2a69cbadbe6f909f4bc41167ec905b8877c5f26292afa13ad18983f6da2bc890fbe33

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/test/dummy/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at timshingyu@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in saaskit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    saaskit (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  saaskit!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tim Cheung
+
+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.

data/README.md

@@ -0,0 +1,81 @@
+# SaaSKit
+
+SaaSKit is the Rails SaaS starter kit for building your SaaS business.
+
+## Requirements
+
+- ruby 2.5 or higher
+- Rails 6.0.0.rc1 or higher
+
+## Installation
+
+Using rails template
+
+```bash
+rails new appname --database=postgresql -m https://link.saaskitapp.com/rqp
+```
+
+or add this line to your application's Gemfile
+
+```ruby
+gem "saaskit"
+```
+
+And then execute:
+
+```bash
+bundle install
+bundle exec rails generate saaskit:install
+```
+
+## Usage
+
+Before you start rails server, Please config your secret credential and use the sample template located in
+`config/credentials.yml.sample` as the starting point.
+
+```yaml
+# config/credentials.yml.sample
+
+# Mailing list subscription
+# -------------------------
+# MailChimp
+# Get API Key: mailchimp admin dashboard > profile dropdown > account > extras dropdown > API keys
+# Get Audience ID: mailchimp admin dashboard > audience > manage audience > settings > Unique id for audience xxx
+
+mailchimp:
+  api_key: your_api_key
+  audience_id: your_audience_id
+```
+
+For development environment:
+```bash
+EDITOR=vim rails credentials:edit --environment development
+```
+
+For test environment:
+```bash
+EDITOR=vim rails credentials:edit --environment test
+```
+
+For production environment:
+```bash
+EDITOR=vim rails credentials:edit
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tgavhq/saaskit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Saaskit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tgavhq/saaskit/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "saaskit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/saaskit/install/install_generator.rb

@@ -0,0 +1,207 @@
+require 'rails/generators/base'
+
+module Saaskit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def add_gems_to_gemfile
+        gem 'meta-tags', '~> 2.11', '>= 2.11.1'
+        gem 'gibbon', '~> 3.2'
+
+        gem_group :development, :test do
+          gem 'standard', '~> 0.0.40'
+        end
+
+        gem_group :development do
+          gem 'eefgilm', '~> 1.2', '>= 1.2.1'
+        end
+      end
+
+      def bundle_install
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+      end
+
+      def organizing_gemfile
+        run "eefgilm"
+      end
+
+      def copy_credentials_sample
+        copy_file "config/credentials.yml.sample"
+      end
+
+      def enable_require_master_key_in_production
+        uncomment_lines "config/environments/production.rb",
+                        /config.require_master_key = true/
+      end
+
+      def install_stimulus
+        run "yarn add stimulus"
+        copy_file "app/javascript/controllers/index.js"
+        insert_into_file "app/javascript/packs/application.js", after: "require(\"channels\")\n" do
+          <<~CODE
+            // Tell webpacker to require stimulus
+            require("stimulus")
+            import 'controllers'
+          CODE
+        end
+      end
+
+      def install_notice_controller
+        copy_file "app/javascript/controllers/notice_controller.js"
+      end
+
+      def install_typed_controller
+        run "yarn add typed.js"
+        copy_file "app/javascript/controllers/typed_controller.js"
+      end
+
+      def install_reveal_controller
+        copy_file "app/javascript/controllers/reveal_controller.js"
+      end
+
+      def install_smooth_scroll_controller
+        run "yarn add smooth-scroll"
+        copy_file "app/javascript/controllers/smooth_scroll_controller.js"
+      end
+
+      def install_aos_controller
+        run "yarn add aos@next"
+        copy_file "app/javascript/controllers/aos_controller.js"
+      end
+
+      def install_noty_controller
+        run "yarn add noty"
+        copy_file "app/javascript/controllers/noty_controller.js"
+      end
+
+      def install_tailwindcss
+        run "yarn add tailwindcss"
+        run "yarn add tailwindcss-transitions"
+        run "yarn add tailwindcss-gradients"
+        run "yarn add tailwindcss-pseudo"
+        copy_file "app/javascript/stylesheets/application.scss"
+        append_to_file "app/javascript/packs/application.js" do
+          <<~CODE
+            require("stylesheets/application.scss")
+          CODE
+        end
+        insert_into_file "app/views/layouts/application.html.erb", after: "<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>\n" do
+          <<~CODE
+            <%= stylesheet_pack_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+          CODE
+        end
+        copy_file "app/javascript/stylesheets/tailwind.config.js"
+        insert_into_file "postcss.config.js", after: "plugins: [\n" do
+          <<~CODE
+            require('tailwindcss')('./app/javascript/stylesheets/tailwind.config.js'),
+            require('autoprefixer'),
+          CODE
+        end
+      end
+
+      def install_purgecss
+        run "yarn add glob-all"
+        run "yarn add path"
+        run "yarn add purgecss-webpack-plugin"
+        copy_file "config/webpack/plugins/purgecss-webpack-plugin.js"
+        insert_into_file "config/webpack/production.js", after: "const environment = require('./environment')\n" do
+          <<~CODE
+            environment.plugins.append('PurgecssWebpackPlugin', require('./plugins/purgecss-webpack-plugin'))
+          CODE
+        end
+      end
+
+      def install_images
+        gsub_file "app/javascript/packs/application.js",
+                  /\/\/ const images/, "const images"
+        gsub_file "app/javascript/packs/application.js",
+                  /\/\/ const imagePath/, "const imagePath"
+
+        copy_file "app/javascript/images/logo_color_horizontal.svg"
+        copy_file "app/javascript/images/logo_color_stacked.svg"
+        copy_file "app/javascript/images/logo_color_symbol.svg"
+        copy_file "app/javascript/images/logo_white_horizontal.svg"
+        copy_file "app/javascript/images/logo_white_stacked.svg"
+        copy_file "app/javascript/images/logo_white_symbol.svg"
+        copy_file "app/javascript/images/tgav_logo_white_symbol.svg"
+      end
+
+      def create_application_controller
+        copy_file "app/controllers/application_controller.rb", force: true
+      end
+
+      def create_application_layouts
+        copy_file "app/views/shared/_head.html.erb"
+        copy_file "app/views/shared/_notices.html.erb"
+        copy_file "app/views/shared/_navbar.html.erb"
+        copy_file "app/views/shared/_footer.html.erb"
+        copy_file "app/views/layouts/application.html.erb", force: true
+        copy_file "app/views/layouts/land.html.erb"
+      end
+
+      def create_application_helpers
+        copy_file "app/helpers/application_helper.rb", force: true
+      end
+
+      def install_meta_tags
+        copy_file "config/initializers/meta_tags.rb"
+        copy_file "app/helpers/meta_tags_helper.rb"
+      end
+
+      def install_pages
+        copy_file "app/javascript/images/pablo-done.png"
+        copy_file "app/javascript/images/github.svg"
+        copy_file "app/javascript/images/rails.svg"
+        copy_file "app/javascript/images/webpack.svg"
+        copy_file "app/javascript/images/stimulus.svg"
+        copy_file "app/javascript/images/tailwind.svg"
+        copy_file "app/javascript/images/layout-top-panel-6.svg"
+        copy_file "app/javascript/images/shield-protected.svg"
+        copy_file "app/javascript/images/facebook.svg"
+        copy_file "app/javascript/images/user.svg"
+        copy_file "app/javascript/images/layout-left-panel-1.svg"
+        copy_file "app/javascript/images/right-circle.svg"
+        copy_file "app/javascript/images/group.svg"
+        copy_file "app/javascript/images/shield-check.svg"
+        copy_file "app/javascript/images/repeat.svg"
+        copy_file "app/javascript/images/credit-card.svg"
+        copy_file "app/javascript/images/sale-2.svg"
+        copy_file "app/javascript/images/file.svg"
+        copy_file "app/javascript/images/stripe.svg"
+        copy_file "app/javascript/images/paypal.svg"
+        copy_file "app/javascript/images/outlet.svg"
+        copy_file "app/javascript/images/notifications-1.svg"
+        copy_file "app/javascript/images/address-book-2.svg"
+        copy_file "app/javascript/images/mail-opened.svg"
+        copy_file "app/javascript/images/sending-mail.svg"
+        copy_file "app/javascript/images/chart-bar-1.svg"
+        copy_file "app/javascript/images/selected-file.svg"
+        copy_file "app/javascript/images/display-1.svg"
+        copy_file "app/javascript/images/cloud-upload.svg"
+        copy_file "app/forms/newsletter_form.rb"
+        copy_file "app/adapters/mailchimp/base_adapter.rb"
+        copy_file "app/models/concerns/coming_soon_pending_subscribable.rb"
+        directory "app/views/pages"
+        copy_file "app/controllers/pages_controller.rb"
+        route "root to: 'pages#home'"
+        route "post '/subscribe', to: 'pages#subscribe'"
+      end
+
+      def create_and_migrate_db
+        rails_command "db:create"
+        rails_command "db:migrate"
+      end
+
+      def tidy_up_codebase
+        run "bundle exec standardrb --fix"
+      end
+
+      def display_readme_in_terminal
+        readme "README"
+      end
+    end
+  end
+end