brianwangila / dial-a-mechanic_sinatra-backend

This is a short Dial A Mechanic backend project written with Sinatra Ruby that lets Users create a mechanic account and rate mechanics. It has two models (Mechanics and Reviews) and employs all the CRUD functionalities.

DIAL A MECHANIC (DAM) BACKEND

By Brian Wangila

Description

DAM is a single-page website that links motorist with car problems to their desired mechanics. The mechanics can be found all over the country, and in major cities and ready to help a stranded motorist get back on their journey. The site also offers mechanics an avenue to get clients and enhance their skills. The mechanics being situated all over the country make it easier for a motorist to get help as soon as they dial a number and explain their situation. This is a backed stack server for DAM with SINATRA Ruby. Follow the below instructions to clone or contribute to this backend server.

Features

• Two models - Mechanics and Reviews
• Has a one-to-many relationship
• Uses ActiveRecord to handle the db
• Has API routes in Sinatra that handle all the CRUD actions for the Active Record models.

Getting Started with DIAL A MECHANIC (with SINATRA)

API Live Link

• Click Here https://sea-lion-app-xkrg8.ondigitalocean.app/ to access DAM webpage

• Access the frontend webpage:

    https://sea-lion-app-xkrg8.ondigitalocean.app/
  

API Live Link

• Click Here to access the live API.

Dial A Mechanic API Repo

• DAM Repo Link

Description

Let us get a deep dive into how to configure routing in SINATRA 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)
• nodejs 9.0+
• RVM installed
• 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 [email protected]:BrianWangila/Dial-A-Mechanic_SINATRA-backend.git 
  

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

• Change directory to the repo folder:

    cd DAM-Sinatra-server
  

• (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) https://github.com/BrianWangila/Dial-A-Mechanic_SINATRA-backend.git
  
    OR
  
    git clone (SHH) [email protected]:BrianWangila/Dial-A-Mechanic_SINATRA-backend.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 rvm

  bundle install
  

• Run the application to start the backed server

  bundle exec rake server    
  
    OR
  
  rake server
  

Authors

This project was created and contributed to by:

• Brian Wangila

License

The project is licensed under Apache 2.0.

The Apache 2.0 [2022] [Brian Wangila] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.