Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 2.22 KB

README.md

File metadata and controls

68 lines (42 loc) · 2.22 KB

KASHU

KASHU

KASHU is your personal assistant, who helps you find your way inside the supermarket. Waste no time during your next grocery shopping trip and take the shortest possible path from the entrance, to the checkout, completing your entire shopping list in the way.

What are you waiting for? Shop with KASHU today!

Get it on Google Play Download on the App Store

Setup Instructions

Backend API

A container runtime, such as Docker, is required. To configure the container, run:

$ docker compose up --build

Mobile Application

To build the mobile application located in the mobile/ directory, you need to use pnpm, a fast, disk space-efficient package manager. Follow these steps to set up and build the mobile application:

  1. Install pnpm

    Ensure you have Node.js installed. If pnpm is not installed, you can install it globally using npm:

    $ npm install -g pnpm
  2. Navigate to the Mobile Directory

    Change your current directory to the mobile/ directory:

    $ cd mobile/
  3. Setup the .env file Create a .env file and define the necessary envarionment variables:

    EXPO_PUBLIC_API_URL=http://exampleUrl:PORT
    
  4. Install Dependencies

    Use pnpm to install the necessary dependencies:

    $ pnpm install
  5. Run the Application

    To run the mobile application on your android device, use the following command:

    $ pnpm run android

    The device must have enabled USB Tethering, File transfer and Developer mode.

Script images folder

The script-images folder contains all of the scripts, used to webscrape the images, resize them and fix their names and location.

The bing_scraper.py file is a GitHub open-source script, that installs the images from Bing. You can find it at GitHub Repository.