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.
Live Link for our API
- 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.
-
Click Here to access Murife webpage
-
Access the frontend webpage:
https://murife-shopping.web.app/
- Click Here to access the live API.
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.
To use this repo on your machine requires some simple steps
-
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.
-
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 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
Please contribute using GitHub Flow. Create a branch add commits and open a pull request.
Technologies used in the project:
- Rails Framework
- Crawler APIs
- RSpec for tests
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.
Please leave a star if you like the project