An open API service indexing awesome lists of open source software.

https://github.com/green-ecolution/frontend

Green Ecolution - Frontend
https://github.com/green-ecolution/frontend

frontend green-ecolution typescript

Last synced: 5 months ago
JSON representation

Green Ecolution - Frontend

Awesome Lists containing this project

README

          



GitHub Release

License
Maintained yes

# Green Ecolution Frontend 🌿

> [!IMPORTANT]
> **This repository has been archived.**
> Active development of the Green Ecolution frontend now continues in the unified **[green-ecolution/green-ecolution](https://github.com/green-ecolution/green-ecolution)** monorepo.
> This repository is no longer maintained β€” please use the new repository for all future contributions and issues.



Smart irrigation is essential to saving water, reducing staff workload, and cutting costs. This project provides the user interface for Green Ecolution β€” a digital system to manage urban greenery efficiently.

πŸ‘‰ For the backend implementation, visit the [Green Ecolution Backend.](https://github.com/green-ecolution/backend)

The frontend connects to the backend and enables users to interact with:

- 🌳 Trees
- 🌿 Tree clusters
- πŸ“‘ Sensors
- πŸ—ΊοΈ Watering plans
- πŸš› Vehicles
- πŸ‘€ Users

Developed in collaboration with **TBZ Flensburg**, this software is designed to be adaptable for other cities. It originated as a research project within the **Applied Computer Science Master's program** at the **University of Applied Sciences Flensburg**.

For further information, visit:

- [🌐 Project website](https://green-ecolution.de/)
- [πŸŽ“ University of Applied Sciences Flensburg](https://hs-flensburg.de/en)
- [πŸ–₯️ Live demo](https://demo.green-ecolution.de)

## Technologies Used βš™οΈ

- [React](https://react.dev/)
- [Vite](https://vitejs.dev/) for fast development and HMR
- [TypeScript](https://www.typescriptlang.org/)
- [ESLint](https://eslint.org/) for code linting
- [PnPM](https://pnpm.io/) for dependency management
- [fnm](https://github.com/Schniz/fnm) for Node.js version management

## Local development πŸ’»

### Requirements

- [Node.js](https://github.com/nodejs/node)
- [PnPM](https://pnpm.io/)
- [fnm](https://github.com/Schniz/fnm)

### Initial Setup βš™οΈ

1. Install the required Node.js version:

```bash
fnm use
```

2. Install pnpm globally:

3. Install dependencies:

```bash
pnpm install
```

## Running the Project ▢️

Build the local backend-client and start the frontend:

```bash
pnpm generate:local
pnpm rebuild
pnpm dev
```

By default, the app connects to the local running backend `localhost:3000`. If you want to use the deployed stage backend instance instead, adjust the `VITE_BACKEND_BASEURL` environment variable:

```bash
pnpm dev:remote
```

### How to Contribute 🀝

We welcome contributions! Please follow these guidelines:

1. Fork this repository.
1. Create a topic branch off develop.
1. Commit your changes.
1. Push your branch to your fork.
1. Open a Pull Request.

This project follows:

- [Git-Flow Workflow](https://danielkummer.github.io/git-flow-cheatsheet/) for branching and releases.
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.

Thank you for helping us improve Green Ecolution! 🌿