🥒 WARZYWNIAX

Motivation

The goal of the project is to create an application that helps farmers and smaller local sellers to sell their products such as fruits, vegetables, nuts, preserves, etc.

With such an application, smaller sellers could reach their customers directly and would not be burdened with the intermediary markup that cuts into their profits. In addition, the application would significantly facilitate the sale of products for very small farmers who may not have the means to advertise and reach a wider audience.

This application could potentially also solve the problem of wasting products that have expired by allowing sellers to mark offers for such products and sell them at a much lower price or even offer free pick-up.

Users who use this application will also have the opportunity to eat healthier and support local businesses. Each user will also be able to contribute to reducing their carbon footprint by better managing food waste.

Requirements

Before you will use this repository make sure that you have installed:

• Git

  • If you are a Windows or macOS user visit this link Downloading Git then download appropriate installer and install it.

  • If you are a Linux (Arch-based distribution) user you can paste bellow scrip into your terminal or visit this page Installing Git

    pacman -S git

• Node.js and npm

  • If you are a Windows or macOS user visit this link Node.js download then download LTS version for Windows and install it.

  • If you are a Linux (Arch-based distribution) user you can paste bellow scrip into your terminal or visit this page Node installation instruction or use nvm

    paru -S nvm
    nvm install node
    nvm use node

• Java 11+

  • If you are a Windows or macOS user visit this link Overview of JDK Installation and follow instructions.

  • If you are a Linux (Arch-based distribution) user you can follow this instructions Installation of the JDK on Linux Platforms or use this command

    pacman -S openjdk

If you followed every step, you should be ready to start using this repository. To make sure that you have installed everything correctly open your terminal git-bash and run the following commands:

• To check git: git --version → you should see output with git version
• To check node.js: node --version → you should see output with node.js version
• To check npm: npm --version → you should see output with npm version
• To check java: javac --version → you should see output with javac version

Downloading the repository

• Open your terminal / git-bash in location where you create a directory which will contain this repository

• Run the following command in your terminal / git-bash

  git clone https://github.com/GDSC-Lodz-University-of-Technology/warzywniax.git
  cd ./warzywniax

Using the repository

Running project

To run this project locally make sure you are in root directory of warzywniax repository, and you have installed all dependencies:

npm i

Then you need to start Firebase emulators first:

npm run firebase:start:emulators

Emulator UI should be available under http://127.0.0.1:4000/

Then in separated terminal you need run the application:

npm run start

App preview should be available under http://localhost:5173/

Documentation

To check documentation please visit wiki page

Scripts

• To start a local web server with HMR for development

  npm run start
  

• To create production build

  npm run build
  

• To start a local web server that serves the built solution

  npm run preview
  

• To start eslint static code analysis report

  npm run lint:ts
  

• To start eslint static doe analysis and fix all auto-fixable errors

  npm run lint:ts:fix
  

• To start eslint static doe analysis and fix all auto-fixable errors in watch mode

  npm run lint:ts:watch
  

• To start code formatter analysis report

  npm run prettyprint
  

• To start code formatter analysis and fix all auto-fixable errors

  npm run prettyprint:fix
  

• To start Authentication, Firestore and Storage emulators

  npm run firebase:start:emulators
  

• To deploy all Firestore security rules, storage security rules and Firestore indexes

  npm run firebase:deploy
  

• To deploy all storage security

  npm run firebase:deploy:storage-rules
  

• To deploy all Firestore security rules

  npm run firebase:deploy:firestore-rules
  

• To deploy all Firestore indexes

  npm run firebase:deploy:firesotre-indexes
  

• To stop tracking changes in db-seed

  npm run git:stop-tracking-db-seed
  

  This can be usefully if you pushed some changes to db-seed, and you want to keep seed ignored