PricePal Frontend

ScreenRecording_10-26-2024.12-58-12_1.mov

Table of Contents

• About Me
• Introduction
• Demo
• Technologies
• Prerequisites
• Installation
• Configuration
• Running the Application
• Usage
• Contributing
• License
• Contact

About Me

Hello! I'm Matin, the creator of PricePal. You can learn more about me and my projects on my website: matin.codes.

I developed PricePal to address the common frustration of finding the best prices across multiple stores. By leveraging the MERN stack and modern mobile technologies, I aim to provide users with a seamless and efficient shopping experience.

Feel free to reach out through GitHub or visit my website for more information!

Introduction

PricePal is an open-source, full-stack MERN (MongoDB, Express, React, Node.js) application designed to help users find the best prices for items across various stores. The frontend is built using React Native with Expo Router, providing a seamless mobile experience, while the backend handles data scraping, database management, and more.

Demo

Coming Soon! A live demo of PricePal will be available shortly. Stay tuned!

Technologies

• React Native: For building the mobile frontend.
• Expo Router: Simplifies navigation within the app.
• MongoDB: Database management.
• Axios: Handling HTTP requests.
• React Native Elements: UI components.
• Puppteer: Web scraping.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js: Installed on your machine. Download Node.js
• Expo CLI: Installed globally. You can install it using:

  npm install -g expo-cli

• Git: Installed on your machine. Download Git

Installation

1. Clone the Repository:

   git clone https://github.com/decompi/pricepal.git

2. Navigate to the Project Directory:

   cd pricepal

3. Install Dependencies:

   npm install

Configuration

1. Backend Setup:

   PricePal Frontend communicates with the backend for data fetching and management. Ensure you have the PricePal Backend set up and running.

2. Environment Variables:

   Create a .env file in the root directory and add the following variables:

   EXPO_PUBLIC_API_BASE_URL=https://your-backend-url.com/api
   EXPO_PUBLIC_API_KEY="yourapikey:

   Replace https://your-backend-url.com/api with the actual URL where your backend is hosted. Replace yourapikey with the actual API Key you set for your backend.

Running the Application

Start the Expo development server:

npx expo start

This will open the Expo Dev Tools in your browser. You can run the app on an emulator or your physical device using the Expo Go app.

Usage

1. Browse Items:
   • Open the app to view a list of available items.
2. Add to Cart:
   • Select items you wish to purchase and add them to your cart.
3. Compare Prices:
   • Navigate to your cart to see price comparisons across different stores.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the Repository
2. Create a Branch:

   git checkout -b feature/YourFeature

3. Commit Your Changes:

   git commit -m "Add Your Feature"

4. Push to the Branch:

   git push origin feature/YourFeature

5. Open a Pull Request

Please ensure your code adheres to the project's coding standards and passes all tests.

License

This project is licensed under the MIT License.

Contact

• Project Link: https://github.com/decompi/pricepal
• Backend Repository: PricePal Backend

---

Happy Shopping with PricePal! 🛒✨