Giter Club home page Giter Club logo

online-shopping-community's Introduction

Murife Online Shopping Community

This is the backend for the Murife online shopping community app where our API exists.
Murife shopping website is used to help customers make the right choice when it comes to purchasing products online. The site gives the user an avenue to search for a product, compare the product's cost and marginal benefits based on prices, ratings, mode of payment etc, and decide which product they want and from which online shop.

shieldsshieldsshieldsshields

Demo ๐Ÿš€

Live Link for our API

This project was contributed to by ๐Ÿฐ:

Features ๐Ÿง

  • Four models - User, UserSearch, Product, and Search
  • Has multiple one-to-many and many-to-many relationships
  • Uses PosgreSQL to handle the db
  • Has API routes in Rails that handle all the CRUD actions for the Active Record models.

๐Ÿ› ๏ธ Installation Steps:

Website Live Link

  • Click Here to access Murife webpage

  • Access the frontend webpage:

      https://murife-shopping.web.app/
    

API Live Link

  • Click Here to access the live API.

Murife Shopping API Repo

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:

      [email protected]:Aimkeys-Sir/online-shopping-community.git 
    
  • Be patient as it creates a copy on your local machine for you.

  • Change directory to the repo folder:

      cd online-shopping-community
    
  • (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/Aimkeys-Sir/online-shopping-community.git
    
      OR
    
      git clone (SHH) [email protected]:Aimkeys-Sir/online-shopping-community.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 rails server    
    
      OR
    
    bundle exec rails s
    
      OR
    
    rails s
    

Contribution Guidelines ๐Ÿฐ :

Please contribute using GitHub Flow. Create a branch add commits and open a pull request.

Built with ๐Ÿ’ป

Technologies used in the project:

  • Rails Framework
  • Crawler APIs
  • RSpec for tests

License ๐Ÿ›ก๏ธ :

The project is licensed under Apache 2.0.

The Apache 2.0 [2022] 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.

Like our work? ๐Ÿ’–

Please leave a star if you like the project

online-shopping-community's People

Contributors

aimkeys-sir avatar brianwangila avatar okubasufrank avatar jajakim22 avatar gatwi avatar kelvinmwendwa avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.