Skip to content

rogerluo410/waroong-shopify

Repository files navigation

Waroong!

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

Tech Stack

  • Ruby 2.6.3
  • Ruby on Rails 6.x.x
  • PostgreSQL 9.5
  • Stripe
  • jQuery
  • Gem:
    • devise | Authentication
    • pg | PostgreSQL library for Ruby

Installation

Requirements

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

  • Ruby. Version 2.6.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
  1. Install the required gems by running the following command in the project root directory:
bundle install
  1. Create and initialize the database:
bundle exec rake db:migrate
  1. Start the development server:
rails s

Setting up the production environment

  1. RAILS_ENV=production rails assets:precompile

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.

Releases

No releases published

Packages

No packages published