https://github.com/malintha-induwara/green-shadow-backend
A Spring Boot-based backend system for Green Shadow Farm Management
https://github.com/malintha-induwara/green-shadow-backend
gradle hibernate java-17 jwt mysql rest-api spring-boot
Last synced: 2 months ago
JSON representation
A Spring Boot-based backend system for Green Shadow Farm Management
- Host: GitHub
- URL: https://github.com/malintha-induwara/green-shadow-backend
- Owner: malintha-induwara
- License: mit
- Created: 2024-10-30T17:05:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-07T15:27:34.000Z (over 1 year ago)
- Last Synced: 2025-03-07T16:28:24.439Z (over 1 year ago)
- Topics: gradle, hibernate, java-17, jwt, mysql, rest-api, spring-boot
- Language: Java
- Homepage:
- Size: 199 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Green Shadow Farm Management System Backend
A comprehensive farm management system backend for Green Shadow Farm, providing robust APIs for managing farm operations, resources, and tracking agricultural activities.
## About The Project
Green Shadow Farm Management System is a specialized backend service designed to streamline and automate farm management processes. The system provides comprehensive APIs for managing various aspects of farm operations, from crop management to equipment tracking.
### Key Features
- **Authentication System**
- User registration and login
- JWT-based authentication
- Refresh token mechanism for sustained sessions
- **Resource Management**
- Crop management with image storage
- Vehicle tracking and maintenance
- Staff records and management
- Equipment inventory
- Field management with dual image support
- **Activity Logging**
- Comprehensive logging system
- Tracks field operations
- Records crop activities
- Monitors staff assignments
- Maintains historical data
## Technology Stack
[](https://spring.io/projects/spring-framework)
[](https://spring.io/projects/spring-data-jpa)
[](https://hibernate.org/orm/)
[](https://gradle.org/)
[![MySQL](https://img.shields.io/badge/Mysql-black?style=for-the-badge&logo=mysql&logoColor=08668E")](https://www.mysql.com/downloads/)
[![POSTMAN](https://img.shields.io/badge/Postman-black?style=for-the-badge&logo=Postman&logoColor=FF713D")](https://www.postman.com/downloads/)
[](https://jwt.io/)
## Getting Started
### Prerequisites
Ensure you have the following installed:
- Java 17 or higher
- MySQL 8.0 or higher
- Gradle
- Your preferred IDE (IntelliJ IDEA recommended)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/malintha-induwara/green-shadow-backend.git
```
2. Configure MySQL database:
```properties
spring.datasource.url=jdbc:mysql://localhost:3306/green_shadow_db
spring.datasource.username=your_username
spring.datasource.password=your_password
```
3. Build the project:
```bash
gradle build
```
4. Run the application:
```bash
gradle bootRun
```
## Project Documentation
### Database Design
The ER diagram for the Green Shadow Farm Management System can be found here:
[View ER Diagram](https://drive.google.com/file/d/1u9ecV1H7YKYDgXaqrsSF-DyOpzETwyA8/view?usp=s)
### Class Structure
The class diagram showing the system's architecture and relationships can be found here:
[View Class Diagram](https://drive.google.com/file/d/1PRyzeWztUqb9Rz5-lXi7nbFhv_ocrOmA/view?u)
## API Documentation
Detailed API documentation is available through Postman:
[View API Documentation](https://documenter.getpostman.com/view/33030562/2sAYBa8UpS)
## Frontend Repository
The frontend repository for this project can be found here:
[Green Shadow Frontend](https://github.com/malintha-induwara/green-shadow-frontend)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.