Getting Started

An overview of how to set up Trado, navigating the demo, contributing to the platform and more.

Overview

Trado is a lightweight, easy to use ecommerce platform; designed to allow developers to quickly deploy a premium ecommerce store for their business. Within minutes you can have your very own online store up and running with all the latest features and technology such as Google Analytics and Merchants, PayPal, Stripe and much more.


Please note, Trado is currently in beta release and is not yet ready for use in a production environment. If you would like to know when it is ready for public release, please sign up here.

Quick Setup

In order to get started quickly, we have created a simple walkthrough of how to set up the Trado platform on your local machine. This will enable you to begin using the application and all of the features it offers. If you would like to enable additional features such as PayPal, Stripe or Google Merchants, please navigate to the modules documentation.

  1. The first step is to clone the repository to your local machine:

    
        git clone https://github.com/Jellyfishboy/trado.git
        
    
  2. Navigate to the project root folder and install the gem dependencies:

    
        cd /Users/myuser/projects/trado
    
        bundle install
    
    
  3. Create your custom secrets.yml from the example supplied on the config directory, secrets.example.yml:

        
        development:
            secret_key_base: wkqndbdnwdjnq
            global_url: 'http://example.com'
            carrierwave_url: 'http://cdn1.example.com'
            asset_url: 'http://cdn%d.example.com'
            mailer_asset_url: 'http://cdn%d.example.com'
            mailer_server: smtp.example.net
            mailer_port: 587
            mailer_domain: www.example.com
            mailer_user_name: me@example.com
            mailer_password: wkqndbdnwdjnq
            aws_s3_id: wkqndbdnwdjnq
            aws_s3_key: wkqndbdnwdjnq
            aws_s3_bucket: example-bucket
            aws_s3_region: eu-region-1
    
    
  4. Amend the database.yml configuration file to use either MySQL or PostgreSQL:

    
        # PostgreSQL
        development:
            adapter: postgresql
            encoding: unicode
            database: trado_dev
            pool: 5
            username: tomdallimore
            password:
    
        # MySQL
        development:
            adapter: mysql2
            encoding: utf8
            database: trado_dev
            pool: 30
            username: root
            password: 
    
    
  5. Create database, set schema and install seeds with the custom Trado rake command:

    
        bundle exec rake trado:install
    
    
  6. Download and install asset dependencies from the Bower configuration:

    
        bower install
    
    
  7. Lastly, you can start up the application using the preconfigured Procfile:

    
        foreman start -f Procfile.dev
    
    

Ready to launch your online store?

Deploy Now

Dependencies

Apart from the standard dependencies required to run Ruby on Rails applications, you will also need to install some third party libraries in order to utilise all the features in the Trado platform.

  • Foreman: Manage Procfile-based applications
  • Memcached: Caching server
  • PhantomJS: Headless WebKit for Rspec test suite
  • ImageMagick: Image processing engine

If you require support installing these dependencies, please feel free to reach out to our community.

Modules

In order to ensure we deliver a lightweight e-commerce platform, we have migrated functionalty into seperate gems which we call 'modules'. This enables developers and business owners to select the functionality which best suits their online store requirements. In each of the gem repositories, you will find a simple step by step guide on how to install the 'module' into the Trado platform.

You can find a full list of modules to use in your store here!

Deployment

The Trado platform has been carefully built to allow developers and business owners to quickly deploy their own online store to the web. In order to get you started and selling straight away, we have created a set of preconfigured guides for popular web services such as Heroku, Amazon AWS, Digital Ocean and Linode.

You can deploy your online store in minutes, click here to get started!

Demo

You can take a look and see how the Trado platform works by navigating to our live demo. Here you can do everything which is available in the latest build, apart from payment functionality such as PayPal and Stripe. The credentials for the administration area is the following:

Please note, the database on the live demo is reset every 24 hours.

Community

Stay up to date on the development of Trado and reach out to the community with these helpful resources:

Licence

Trado is released under the MIT license and is copyright 2016 Tom Dallimore. Boiled down to smaller chunks, it can be described with the following conditions.

It requires you to:

  • Keep the license and copyright notice included in the Trado source files when you use them in your works

It permits you to:

  • Freely download and use Trado, in whole or in part, for personal, private, company internal, or commercial purposes
  • Use Trado in packages or distributions that you create
  • Modify the source code
  • Grant a sublicense to modify and distribute Trado to third parties not included in the license

It forbids you to:

  • Hold the authors and license owners liable for damages as Trado is provided without warranty
  • Hold the creators or copyright holders of Trado liable
  • Redistribute any piece of Trado without proper attribution
  • Use any marks owned by Tom Dallimore in any way that might state or imply that Tom Dallimore endorses your distribution

It does not require you to:

  • Include the source of Trado itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it
  • Submit changes that you make to Trado back to the Trado project (though such feedback is encouraged)

The full Trado license is located in the project repository for more information.

Translations

Trado is currently looking for translators to contribute to the platform. If you would like to help translate the platform, you can get started here.

The languages Trado is actively seeking translators for are as follows:

  • Czech
  • Chinese
  • Danish
  • Dutch
  • Finnish
  • French
  • German
  • Italian
  • Portugese
  • Russian

If you would like to contribute to a language translation which is not listed above, please feel free to reach out to get in contact.