/Shopping-analu

This is our final project before graduation. We must do our absolute best. An E-Commerce system that analyses data from other e-shops s as to generate the best option for the client.

Primary LanguageRuby

README

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

  • Ruby version *https://github.com/kamausuzan197/Shopping-analu.git

  • System dependencies

  • Configuration

  • Database creation

  • Database initialization

  • How to run the test suite

  • Services (job queues, cache servers, search engines, etc.)

  • Deployment instructions

  • ...

how to run this project on your machine

  • clone the repo
- cd directory to shopping-anulu

#### start the ui
our client side is in React, cs, material ui.
-first change directory to client

cd client

- then install dependanicies using

yarn install

or

npm install

- then start the app

npm start


#### start the api
our api is in ruby on rails
- change directory to app

cd app

- then install dependanicies using 
bundle install
  • build to compile into react
yarn build
  • then run the api
rails s

useful links

install yarn if you don't have https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable

contributing Guide

clone the repo using the below command

git clone https://github.com/kamausuzan197/Shopping-analu/client/App.js

then after cloning open on vscode or any other IDE

cd App.js && code .

make sure to branch out the main branch using

git branch branch-name && git switch branch-name

make your changes. then commit using

git add <filename>

write a good commit message describing your change

git commit -m 'feat:did this change'

then push code to the new branch you created using

git push origin branch-name

create a pull request and request for a review


happy to see you contribute