FieldGuardian-FRONTEND

Welcome to the FieldGuardian frontend repository! This frontend application serves as the user interface for a comprehensive crop monitoring system for Green Shadow (Pvt) Ltd. It enables efficient management of fields, crops, staff, vehicles, and equipment, ensuring high-quality production and streamlined operations.

View Design · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. API Documentation
4. Figma Design
5. Backend Repository
6. License

About The Project

Green Shadow (Pvt) Ltd. is a mid-scale farm specializing in root crops and cereals. The company operates at both national and international levels and is renowned for high-quality production. Due to recent growth, the management has decided to introduce a comprehensive system to manage their crops and other assets. The proposed project will focus on systemizing the following areas:

• Field: Represents the land allocated for cultivation, with several fields designated for specific crop types.
• Crop: Refers to the type of crop grown in a particular field.
• Staff: Manages human resources as well as field and crop operations.
• Monitoring Log: Records observations and activities related to fields and crops.
• Vehicle: Manages vehicles assigned to staff for monitoring and supporting agricultural operations.
• Equipment: Oversees the agricultural equipment used in various operations.

User Interface

• Clean interface built with HTML, CSS, and Bootstrap.
• Dynamic elements for user interaction powered by JavaScript.

Built With

This project was developed using a variety of modern web technologies and libraries to ensure a responsive and dynamic user experience.

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow these steps to set up the project locally and get it running on your machine. The instructions will guide you through the process of cloning the repository, and configuring any required settings.

Prerequisites

Before setting up the project, make sure you have the following tools and libraries installed or configured as needed:

• Axios
  Axios is already included in the project. No additional installation is required.

• Bootstrap
  Bootstrap has already been downloaded and set up for the project.

Installation

Follow these steps to install and set up the project on your local machine:

1. Clone the repository

   git clone https://github.com/gayanukabulegoda/FieldGuardian-FRONTEND.git

2. Change git remote URL to avoid accidental pushes to the base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes

(back to top)

API Documentation

Refer to the Postman API Documentation for detailed API endpoints and usage instructions.

Figma Design

Check out the Figma design for the frontend here.

Backend Repository

Access the backend repository on GitHub here.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

© 2024 Gayanuka Bulegoda