Skip to content

Open-Gea/Client-Open-Gea

Open Gea - Front End v2.0.0

Origin in YvY

In this project, you will see the word YvY many times. YvY means Earth in Guaraní, just like Gea in ancient Greek. YvY is the original, non-open source project from which Gea is inspired.

Types of Users

Gea offers two possibilities when registering:

  • Producer: Control your farms, calculations such as water or carbon footprint, agronomic data, QR code, and among other functions available in Gea.

  • Organization: Control the members of your organization and their respective farms, calculations, georeferencing, among other functions available in Gea.

Also, there is an admin role for developers and administrators of Gea:

  • Administrator: Control the access to Gea, other general data and statistics.

Modules Available

The application covers these principal modules for Producers:

  • User Profile.
  • Farms and Product Management.
  • Calculation of Carbon Footprint and Water Footprint.
  • Watering Needs.
  • Agronomic Data.
  • Weather Forecast.
  • Seasonal Forecast.
  • Historical Records with Farms/Lots Information, Agriculture Production, Accounting and Staffing.
  • Soil Regeneration Plan.
  • Historical Records
  • Sustainability Self-Assessment.
  • QR Code.
  • Organizations with their Invitations and Requests.

Also, we have these modules available for Organizations:

  • Organization Profile.
  • Farms Management.
  • Carbon Footprint and Water Footprint Management.
  • General Management.
  • Agronomic Data Management.
  • Members Management.
  • Georeferencing.

And we have these modules available for Administrators:

  • Administration, handle users and countries available in the application with their permissions.
  • Statistics, get information about the users per country and number of users registered per year/country.

Project Roadmap

Participation is welcomed from software developers, designers, testers, agronomists/agri experts/soil experts, IoT engineers, researchers, students, farmers, and others who can help improve the quality and value of the solution for small farmers around the world.

Please check the issues to see how you can contribute to the project

Getting Started

Technologies

The main technology used in client gea app are:

  • react.js

    React Js

    For components

  • redux

    Redux

    For local storage, routers and guards

  • material-ui

    Material UI

    For styling

  • i18n

    i18 Next:

    For translations English and Spanish

  • axios

    Axios

    For http client-server communication

  • vite

    Vite

    For building and developments tools

Gea App - Setup Guide

Cloning the Repository

https://github.com/open-gea/Client-Open-Gea
cd client-open-gea

Dependencies Installation

You require npm installed 🤷‍♀️

npm install

Running the Client Gea Locally

To set up and run the gea-app for a local environment:

  • Create a .env file in the root directory of your client-open-gea and populate with the following:
# Must be the url endpoint where the backend server is running. 
VITE_YVY_BACKEND_BASE_URL=http://localhost:8001 

#Vite uses this port to run the app locally in development mode. Check the port once you run it and change this variable if you need to.
VITE_YVY_APPDOMAIN=http://localhost:5173 

# In order to restart the local storage, redux uses numbers version of it. Every time you change it, localstarage will be reset. Can be any number
VITE_YVY_LOCALSTORAGE_VERSION=1

Starting the Project

npm run dev

Contributors

Contributing

Please contact the members of this list:

About

Client app for open yvy project

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors