otsembo / Clarks

A simple e-commerce application built with Ruby on Rails

Clarks

Description

Clarks is an e-commerce shoe store built with Ruby on Rails.

Tools

The following were the tools used to build this application:

• JWT
• SQLite3
• Rails
• Ruby

Getting Started

In order for you to use the content on this repo ensure you have the following:

• A computer that runs on either of the following; (Windows 7+, Linux, Mac OS)
• Ruby 2.7.2+
• Some bit of patience for your own sanity.

Installation

To use this repo on your machine requires some simple steps

Alternative One

• Open a terminal / command line interface on your computer

• Clone the repo by using the following:

    git clone https://github.com/otsembo/Clarks.git
  

• Be patient as it creates a copy on your local machine for you.

• Change directory to the repo folder:

    cd Clarks
  

• (Optional) Open it in Visual Studio Code

    code .
  

• (Alternate Option) Open it in any editor of your choice.

• Hurray! You are one step closer to being as intelligent as Einstein.

Alternative Two

• On the top right corner of this page there is a button labelled Fork.

• Click on that button to fork the repo to your own account.

• Take on the process in Alternative One above.

• Remember to replace your username when cloning.

    git clone https://github.com/your-username-here/Clarks.git
  

Running the application

Running the application is very straight forward. You can use the following steps to run the app.

• Install required dependencies from rubygems

  bundle install
  

• Run the server

  rails s
  

• Check the API endpoints available

  rails s
  

Authors

This project was contributed to by:

• Ian Okumu

License

The project is licensed under Apache 2.0.