https://github.com/binos30/shopline
E-commerce app using Rails 7, PostgreSQL, Hotwire (Turbo + Stimulus), Tailwind CSS, Cloudinary, and Stripe
https://github.com/binos30/shopline
e-commerce e-commerce-app e-commerce-project ecommerce ecommerce-app hotwire-stimulus hotwire-turbo mvc mvc-framework rails rails-application rails-crud ruby ruby-on-rails stimulus-rails turbo-rails web-framework
Last synced: 9 months ago
JSON representation
E-commerce app using Rails 7, PostgreSQL, Hotwire (Turbo + Stimulus), Tailwind CSS, Cloudinary, and Stripe
- Host: GitHub
- URL: https://github.com/binos30/shopline
- Owner: binos30
- License: mit
- Created: 2024-01-06T15:59:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T20:20:04.000Z (over 1 year ago)
- Last Synced: 2024-11-20T14:50:45.378Z (over 1 year ago)
- Topics: e-commerce, e-commerce-app, e-commerce-project, ecommerce, ecommerce-app, hotwire-stimulus, hotwire-turbo, mvc, mvc-framework, rails, rails-application, rails-crud, ruby, ruby-on-rails, stimulus-rails, turbo-rails, web-framework
- Language: Ruby
- Homepage: https://shopline-t6yk.onrender.com
- Size: 5.69 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shopline
[](https://badges.pufler.dev)
[](https://badges.pufler.dev)
[](https://github.com/binos30/shopline/actions/workflows/ci-cd.yml)
[](https://dependabot.com)
E-commerce app. Shop online with Shopline. You shop, we ship!
## Setup
Prerequisites
- [Ruby 3.3.5](https://github.com/rbenv/rbenv)
- [PostgreSQL](https://www.postgresql.org/download/)
- [Node.js ^20.15.1](https://github.com/nvm-sh/nvm)
Create `.env` file at the root of the project directory. Copy the content of `.env.template.erb` to `.env` then update the `username` and `password` based on your database credentials. Get `STRIPE_SECRET_KEY` and `STRIPE_WEBHOOK_SECRET` from your [Stripe](https://dashboard.stripe.com) account.
To enable error monitoring with Honeybadger:
1. Sign up for a [Honeybadger](https://www.honeybadger.io/) account
2. Create a new project in Honeybadger
3. Get your project's API key from the project settings
4. Add the API key to your `.env` file as `HONEYBADGER_API_KEY`
Install dependencies and setup database
```bash
bin/setup
```
Re-enable git hooks _(Run this command only if you've already set up the application prior to the migration from husky to lefthook)_
```bash
git config --unset core.hooksPath
```
Run `lefthook install` to sync the git hooks
Start local web server
```bash
bin/dev
```
Go to [http://localhost:3000](http://localhost:3000)
Use [Stripe CLI](https://docs.stripe.com/stripe-cli) to simulate Stripe events in your local environment or [learn more about Webhooks](https://docs.stripe.com/webhooks)
```bash
stripe listen --forward-to localhost:3000/stripe_webhooks
```
## Testing Payments
To test Stripe payments, use the following test card details:
- Card Number: `4242 4242 4242 4242`
- Expiration: Any future date
- CVC: Any 3-digit number
## Set up a production Stripe webhook
1. Go to the [Stripe Dashboard](https://dashboard.stripe.com) and create a new webhook for your production environment.
2. Set the endpoint URL to your production route (e.g., `https://yourdomain.com/stripe_webhooks`).
3. Select the events you want to listen for (e.g., `checkout.session.completed`, `customer.created`, `customer.deleted`).
## GitHub Actions, Linting and Security Auditing
GitHub actions are setup to lint, test, and deploy the application.
You can also run these actions locally before pushing to see if your run is likely to fail. See the following gems / commands for more info.
- [Brakeman](https://brakemanscanner.org/) - Security audit application code
```bash
bin/brakeman --no-pager
```
- [Brakeman: Ignoring False Positives](https://brakemanscanner.org/docs/ignoring_false_positives) - Creating and Managing an Ignore File
```bash
bin/brakeman -I --no-pager
```
- [Bundler Audit](https://github.com/rubysec/bundler-audit) - Security audit dependencies
```bash
bin/bundler-audit --update
```
- [Rubocop Rails Omakase](https://github.com/rails/rubocop-rails-omakase) - Ruby Linter
```bash
bin/rubocop
```
**Note:** Some linters like `ESLint`, `Prettier`, etc. will automatically run on `pre-commit` git hook.
## Testing
Setup test database
```bash
bin/rails db:test:prepare
```
Default: Run all spec files (i.e., those matching spec/\*\*/\*\_spec.rb)
```bash
bin/rspec
```
or with `--fail-fast` option to stop running the test suite on the first failed test. You may add a parameter to tell RSpec to stop running the test suite after N failed tests, for example: `--fail-fast=3`
```bash
bin/rspec --fail-fast
```
Run all spec files in a single directory (recursively)
```bash
bin/rspec spec/models
```
Run a single spec file
```bash
bin/rspec spec/models/product_spec.rb
```
Run a single example from a spec file (by line number)
```bash
bin/rspec spec/models/product_spec.rb:6
```
Use the plain-English descriptions to generate a report of where the application conforms to (or fails to meet) the spec
```bash
bin/rspec --format documentation
```
```bash
bin/rspec --format documentation spec/models/product_spec.rb
```
See all options for running specs
```bash
bin/rspec --help
```
## Code Coverage
[Coverage]: https://docs.ruby-lang.org/en/3.3/Coverage.html "API doc for Ruby's Coverage library"
[SimpleCov]: https://github.com/simplecov-ruby/simplecov "A code coverage analysis tool for Ruby"
[SimpleCov][SimpleCov] is a code coverage analysis tool for Ruby. It uses [Ruby's built-in Coverage][Coverage] library to
gather code coverage data, but makes processing its results much easier by providing a clean API to filter, group, merge, format,
and display those results, giving you a complete code coverage suite that can be set up with just a couple lines of code.
SimpleCov/Coverage track covered ruby code, gathering coverage for common templating solutions like erb, slim and haml is not supported.
After running your tests, open `coverage/index.html` in the browser of your choice. For example, in a Mac Terminal,
run the following command from your application's root directory:
```bash
open coverage/index.html
```
in a Debian/Ubuntu Terminal,
```bash
xdg-open coverage/index.html
```
**Note:** [This guide](https://dwheeler.com/essays/open-files-urls.html) can help if you're unsure which command your particular
operating system requires.