summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.md1
-rw-r--r--PULL_REQUEST_TEMPLATE.md19
-rw-r--r--README.md4
-rw-r--r--lib/super_good-solidus_taxjar.rb3
-rw-r--r--lib/super_good/engine.rb8
5 files changed, 34 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 75cdefb..8e455dc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,7 @@
- [#21](https://github.com/SuperGoodSoft/solidus_taxjar/pull/21) Migrated project to `solidus_dev_support`
- [#22](https://github.com/SuperGoodSoft/solidus_taxjar/pull/22) Added support for TaxJar address validation API through `SuperGood::SolidusTaxJar::Addresses` class
- [#34](https://github.com/SuperGoodSoft/solidus_taxjar/pull/34) Include API version in request headers
+- [#38](https://github.com/SuperGoodSoft/solidus_taxjar/pull/38) Added a rails engine to support future solidus backend UI
## v0.17.1
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..8c254a7
--- /dev/null
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,19 @@
+What is the goal of this PR?
+---
+
+
+
+How do you manually test these changes? (if applicable)
+---
+
+1. Do a thing
+ * [ ] Assert a result
+
+Merge Checklist
+---
+
+- [ ] Run the manual tests
+- [ ] Update the changelog
+
+Screenshots
+---
diff --git a/README.md b/README.md
index ae71373..70ed420 100644
--- a/README.md
+++ b/README.md
@@ -65,7 +65,9 @@ The extension provides currently two high level `calculator` classes that wrap t
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Before installing dependencies, make sure your environment variables are setup. Our CI uses something like this: `SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0`. These environment variables need to be set when installing dependencies and running specs, so set them before the command like this: `SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0 bin/setup`
+
+Run `bin/setup` to install dependencies. Then, run `rake spec` 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).
diff --git a/lib/super_good-solidus_taxjar.rb b/lib/super_good-solidus_taxjar.rb
index f7f97c7..768d9f8 100644
--- a/lib/super_good-solidus_taxjar.rb
+++ b/lib/super_good-solidus_taxjar.rb
@@ -1 +1,4 @@
+# frozen_string_literal: true
+
require "super_good/solidus_taxjar"
+require "super_good/engine"
diff --git a/lib/super_good/engine.rb b/lib/super_good/engine.rb
new file mode 100644
index 0000000..a73edd5
--- /dev/null
+++ b/lib/super_good/engine.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SuperGoodSolidusTaxjar
+ class Engine < Rails::Engine
+ isolate_namespace Spree
+ engine_name 'super_good-solidus_taxjar'
+ end
+end