omkz / waroong

Simple E-Commerce Website built with Ruby On Rails 7

Waroong!

Waroong is an open-source e-commerce solution based on Ruby on Rails 7.

Tech Stack

• Ruby 3.x
• Ruby on Rails 7.x
• PostgreSQL 9.5
• Esbuild
• Twitter Bootstrap 5
• Stripe
• Gem:
  • devise | Authentication
  • pg | PostgreSQL library for Ruby

Installation

Requirements

Before you get started, the following needs to be installed:

• Ruby. Version 3.1.0 is currently used and we don't guarantee everything works with other versions. If you need multiple versions of Ruby, rbenv is recommended.
• RubyGems
• Bundler: gem install bundler
• Git
• A database. Only PostgreSQL 9.5 has been tested, so we give no guarantees that other databases (e.g. MySQL) work. If you're using OS X and have Homebrew installed, install it with brew install postgresql

Setting up the development environment

1. Get the code. Clone this git repository:

git clone git://github.com/omkz/waroong.git
cd waroong

2. Install the required gems by running the following command in the project root directory:

bundle install

3. Setup the database:

bundle exec rails db:setup

4. Start the development server:

bin/dev

If you want to contribute

The best way to contribute is to do one of the following :

• Creating tests
• Refactoring
• Coding features
• Correcting logged issues
• Correcting my English! (I'm an Indonesian, so don't hesitate to fix my sentences or whole paragraphs.)

License

Waroong is open source under the MIT license. See LICENSE for details.