An Ingressive for Good x Zuri Project ## Table of Content * [Overview](#overview) * [Technologies Used](#technologies-used) * [Features](#features) * [Requirements](#requirements) * [How to Contribute](#how-to-contribute) * [Setup and Installation](#setup-and-installation) * [Contributors](#contributors) * [Acknowledgment](#acknowledgment) * [Team Links](#team-links) ## Overview __About Us__ Wallet friendly is an online platform which compares the prices of products across different platforms. __Vision__ To be among the top 20% companies in the e-commerce industry. __Mission__ To help buyers get quality goods at the best price. __Live Link__: https://wallet-fiendly.herokuapp.com __Project Status__: _in progress_ ## Technologies Used - __Design__
 - __Frontend__
   - __Backend__
  - __Database__
 - __Project Mnagement__
 ## Features `Create Account` Users are able to sign up on wallentfriendly with their email, phone number, facebook and password. `Login` Retrieves users sign up details from a database compares the inputted login details and allows authenticated users gain full access to the platform. `Documentation` Users have full access to view and interact with the documentation. `Comment` Authenticated users have the ability to comment about a product. `Share` Authenticated users can share links to a product on Facebook. `Purchase Page` Links to the stores are made available to authenticated users. `Search Bar` Enables users to search for various products by specifying their desired product. `Responsive` Enables users to access the platform via their various devices without any issues with their display. ## Requirements * An IDE * Git & GitHub * A compatibility browser * Python 3.7+ ## How to Contribute - __Fork the project repository__
In the project repository on github click the fork button in the upper right corner - __Clone the forked repository to your local machine__ ```ruby git clone https://github.com/zuri-training/WF-PriceCompare-24.git ``` - __Navigate to the local directory and open in your IDE/ Text Editor__ - __In the IDE terminal set upstream branch__ ```ruby git remote add upstream https://github.com/zuri-training/WF-PriceCompare-24.git ``` - __Pull upstream__ ```ruby git pull upstream dev ``` - __Create a new branch to make your changes__ ```ruby git checkout -b ``` - __Stage the file__ After making edits, type the below command in your terminal ```ruby git add ``` - __Commit changes__ ```ruby git commit -m "your_message" ``` - __Push your local changes__ ```ruby git push origin ``` - __Create a pull request__ - __Wait till the admin accepts and merges your pull request__ ## Setup and Installation __In your IDE run the following commands in the terminal to setup__ - Install environment in the root directory `WF-PriceCompare` ``` ruby pip install virtualenv ``` - Create the virtual environment in the same root directory ``` ruby virtualenv ``` - Activate virtual environment ``` ruby \scripts\activate ``` - Install all packages/ Dependencies used ``` ruby pip install -r requirements.txt ``` - Run Migrations when changes are made ``` ruby python manage.py migrate ``` - Run Server ``` ruby python manage.py runserver ``` ## Contributors |__Name__ | __Slack Username__| |:--------|:------------------| | [Oputa Olivia](https://github.com/oputaolivia)| `Oputa Olivia`| | [Nkiru Oduenyi](https://github.com/nkirusteph)| `NkiruOdunenyi`| | [Dolapo Mosuro](https://github.com/Dolapo-Mosuro)| `dolapoololade`| | [Idisi Efezino](https://github.com/efezinoidisi) | `Efezino`| | [Olasupo Habeeb](https://github.com/olasb) | `Olasbee`| | [Elizabeth Asieba](https://github.com/asiebaelizabeth) | `Elizabeth Asieba`| | [Adefila Islamiyyah Adebimpe](https://github.com/MiyyahCodes) | `MiyyahCodes`| | [Uwakmfon Etim](https://github.com/Wakygrace) | `Uwakmfon`| | [Chibuike Otiji](https://github.com/Charles3K14) | `Charles3K14`| | [Oye Haruna Ibrahim](https://github.com/Oye-Ibrahim) | `Oye`| | [Kemi Rokosu](https://github.com/kemirokosu) | `Kemi Rokosu`| | [Ezeh Victoria](https://github.com/Ezeh-Vikki1635) | `Ezeh Victoria`| | [Victor Nwimo](https://github.com/Vicwin13) | `VicWin`| | [Oluniyi Oladunjoye](https://github.com/niyi-olad) | `Niyi`| | [Oshin Oluwafemi Elijah](https://github.com/SirCalvary) | `Oshin Oluwafemi Elijah`| | [Jadesola Kareem](https://github.com/jadesola123) | `Jadesola Kareem`| | [Dada Oluwasegun](https://github.com/Shegzyrey) | `Dada oluwasegun`| | [Mavis Oghenesuvwe](https://github.com/MavisOdis) | `Mavis`| | [Jonathan Ikpen](https://github.com/jonathan-ikpen) | `Codeamant`| | [Daniel Ndukwe](https://github.com/fantome76) | `Daniie`| | [Olaitan Kolawole](https://github.com/Powelldabig) | `Olaitan Kolawole`| | [Babatunde Oluwaseun](https://github.com/Mayana74) | `Mayana`| | [Abiola Ayodele](https://github.com/babboe1) | `babboeCodes`| ## Acknowledgment Appreciating the [Ingressive For Good X Zuri Team](https://training.zuri.team/) for this wonderful initiative. During the course of this program majority of the participants have been stretched beyond their limits going outside of their comfort zone seeking solutions, which has broaden their scope. ## Team Links - [Project Brief](https://bit.ly/Team24_PriceCompare_Brief) - [DataBase Schema](https://bit.ly/Team24_PriceCompare_DataBaseSchema) - [Frontend Documentation](https://bit.ly/Team24_PriceCompare_FrontendDoc) - [Backend Documentation](https://bit.ly/Team24_PriceCompare_BE_Doc) - [Research Report](https://bit.ly/Team24_PriceCompare_Research) - [Figma Board](https://bit.ly/Team24_PriceCompare_FigmaBoard) - [Slides](https://www.canva.com/design/DAFHbeze7Nw/n6F3XGAqUlZkHroeOl9C8g/edit?utm_content=DAFHbeze7Nw&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton) - [Task Sheet](https://bit.ly/Team24_PriceCompare_TaskSheet)