frontend-smartfarming/README.md

70 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2024-10-14 02:52:56 +00:00
# Agrilink Vocpro (Smart Farming Web Application)
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
A Website application that using Angular 18 for monitoring greenhouse conditions with IoT device that have 2 NPK, DHT, and BH1750 sensors
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
## Overview
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
This application enables user to monitor greenhouse conditions by IoT device that include 2 NPK, DHT, and BH1750 sensors.
The data that will display on the graph is 24 hour trend data and there will be last 1 hour data on the card interface
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
## Features
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
- Monitor sensor data
- User authentication
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
## Technology Stack
2024-08-05 08:16:27 +00:00
- Node JS version 18.20.4
- Angular 18.2.4 (Front-end Web Framework)
2024-10-14 02:52:56 +00:00
- REST API (Backend communication)
- GitLab for version control
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
## Angular Dependency Stack
This project uses several packages to support various functionalities. Here is a list of the key dependencies:
- **[Chart.js](https://www.chartjs.org/)**: A powerful JavaScript library used for creating dynamic, interactive charts in the application.
- **[Bootstrap](https://getbootstrap.com/)**: A front-end framework for building responsive and mobile-first web designs, providing pre-designed components and utilities.
- **Event Listener**: Used to manage events like resizing the window, allowing the chart to adjust automatically to screen size changes.
- **[Angular FormsModule](https://angular.io/api/forms/FormsModule)**: Supports template-driven forms, enabling form handling and user input in the application.
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
## Installation Guide
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
1. Clone the repository:
```
git clone https://gitlab.com/profile-image/kedaireka/smartfarming/frontend-smartfarming.git
```
2. Navigate to the project directory:
```
cd agrilink_vocpro
```
3. Install Dependencies:
```
npm install
```
4. Run the project:
2024-10-14 02:52:56 +00:00
```
ng serve
```
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
## Project Structure (Angular)
2024-08-05 08:16:27 +00:00
2024-10-14 02:52:56 +00:00
- `src/app/`: Contains the Angular application source code.
- `cores/`: Contains all constants, interfaces, and services needed for the project.
2024-12-30 06:55:16 +00:00
- `guards/`: Contains guards for managing access some routes in application
- `interceptors`: Contains handling error
2024-10-14 02:52:56 +00:00
- `interfaces/`: Contains TypeScript interfaces for data models and types used throughout the application.
- `services/`: Contains service files for managing API requests.
- `pages/`: Contains Angular components and views representing different pages of the application.
- `angular.json`: Angular project configuration file.
- `package.json`: Contains project dependencies and scripts for building and running the project.