Tvarkau Lietuvą Frontend

This repository contains the source code and documentation for the Tvarkau Lietuvą Frontend, developed by the Aplinkos Ministerija.

Table of Contents

• About the Project
• Getting Started
  • Installation
  • Usage
  • API Client Generation
• Deployment
• Contributing
• License

About the Project

The Tvarkau Lietuvą Frontend is a system designed to publicly disclose all the known and potentially illegal waste generation sites to the Department of Environmental Protection. The system allows the public to report previously unrecorded sites and track the status of their investigation.

Key features of the Frontend include:

• Provides ability to create trash reports.
• Retrieves reported trash locations, investigation status.
• Gets information about dumps.

Getting Started

To get started with the Tvarkau Lietuvą Frontend, follow the instructions below.

Installation

1. Clone the repository:

   git clone https://github.com/AplinkosMinisterija/tvarkau-lietuva-frontend.git

2. Install Flutter https://docs.flutter.dev/get-started/install and Melos https://melos.invertase.dev/

3. Install the required dependencies:

   cd tvarkau-lietuva-frontend
   melos bootstrap 

Usage

In order to launch the application you need to provide Google Maps API key. Generate one with these instructions

Insert the key in the web/index.html file:

<script src="https://maps.googleapis.com/maps/api/js?key=YOUR_KEY_HERE"></script>

Start the application:

flutter run --flavor dev

API Client Generation

Generate the API client from the OpenAPI contract in openapi.yaml using openapi_generator. Run the command below:

dart run build_runner build --delete-conflicting-outputs

Deployment

Preview

Each commit creates a new preview environment automatically on pull request to the main branch.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. For more information, see the contribution guidelines.

License

This project is licensed under the MIT License.