ONWaRD is short for Online Network for Writing and Retrieving Data. This is a REST API service built with the Spring Boot framework that allows a platform where companies can electronically manage all their data, enabling them to go paperless.
This application demonstrates how to utilize Microsoft .NET Maui Framework, Spring Boot application, and Project Lombok to work together to create an innovative product.

• Technologies Used
• Extension on Visual Studio Code
• Requirements
• Installation
• Contributing
• License
• Acknowledgements

Technologies Used

The following technologies were used to build this application:

• Java 17 LTS
  
• Spring Boot 3
  
• Maven
  
• Project Lombok
  
• Microsoft .NET Maui Framework
  
• C#
• XAML
• JSON
• Visual Studio Code
  

Extension on Visual Studio Code

The following Extension were used in Visual Studio Code:

• Extension Pack for Java v0.25.15
  
• Spring boot Extension Pack v0.2.1
  
• .NET Extension Pack v1.0.13
  
• C# v2.22.5
  
• CS-Script v2.2.1
  Optional:
• Eclipse Temurin v21.0.2+13
  

Requirements

• Having Java 17 LTS or later installed.
  You can download it from bellsoft's website.

• Having a software project management and comprehension tool.
  Install Apache Maven 3.9.6 from Maven's website.

• Having Microsoft .NET Maui Framework for the Front end.
  Install Microsoft .NET Maui Framework 8.0.3 from Microsoft's website.

• Having Extension Pack for Java.
  You can download it from Visual Studio's marketplace.

• Having developed and deployed Spring Boot Application in Visual Studio Code.
  Install Spring boot Extension Pack Visual Studio's marketplace. Alternatively, Your preferred IDE also has a Spring Boot extension option.

  *(Optional)having a open source JavaSE build based on OpenJDK.This might be needed if you do not have a binary build of OpenJDK.
  Install Eclipse Temurin Adoptium.

Installation

1. Clone this repository to your local machine using this command:
   git clone https://github.com/jack-turk-5/onward
2. Import the project into your IDE (such as Eclipse or Visual Studio code).
3. start the application from OnwardApplication.java
4. Run the application as a Spring Boot application (usually located in your IDE), or use the Maven plugin mvn spring-boot:run.
5. Go to localhost:8080/ on your web browser.

*Try adding endpoints with simple text and stuff, follow the template for greeting and add endpoint methods to DemoController, just make sure you do it in the form @GetMapping("/YOURTEXTHERE") The first slash is important

Architecture

Backend

• Spring Boot 3 & Java 17 LTS: The core of our backend services, providing REST API endpoints for data management and retrieval. It's configured for high availability and resilience, allowing for scalable microservices architecture.
• Maven: Used for dependency management and project build, Maven facilitates our continuous integration and deployment pipeline, ensuring consistent builds and version management.
• Project Lombok: Integrated to reduce boilerplate code, such as getters/setters, making the codebase more readable and easier to maintain.

Frontend

• Microsoft .NET MAUI Framework: Our choice for the frontend to create a responsive and interactive user interface that operates across different platforms (Windows, macOS, iOS, Android) with a single codebase.
• C# and XAML: The primary languages used for development, where C# provides the logic and XAML defines the UI layout and design. This combination ensures a powerful yet flexible way to build our app’s interface.

Development Environment

• Visual Studio Code: The main Integrated Development Environment (IDE) used for the project, supported by various extensions to enhance productivity, such as: Extension Pack for Java, Spring Boot Extension Pack, .NET Extension Pack, and more for comprehensive development support.

Integration and Data Management

• JSON: Standard format for data exchange between the frontend and backend, ensuring compatibility and ease of data manipulation.
• API Endpoints: RESTful services designed for efficient data writing and retrieval, supporting various functionalities needed by the application.

Knowledge Gained

We learned to combine Spring Boot, Microsoft .NET framework, and Project Lombok to create a product.

• Spring Boot 3 basic functionality and implementation.
• Understand the Basics implementation of the Microsoft.NET framework in building multi-platforms app in the C# codebase.
• Converting data into and out of JSON into different formats.
• Follow Software Engineering principles.
• Implement the basic Project Lombok functions to boost productivity in development.

Contributing

To make effective contributions to this software, follow these steps:

1. Fork this repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your changes.
4. Make your changes and commit with descriptive commit messages in the following format:
5. Push your changes to your GitHub account.
6. Create a pull request from your branch to the original repository's main branch. When making contributions, please keep the following in mind:
   • Follow the code style and formatting guidelines used in the project.
   • Follow the format for commit messages and be concise.
   • Make sure that your changes do not break existing functionality. *Write tests for any new code and ensure that all existing tests pass.

License

Users outside have the right to use, copy, modify, and distribute the code included in this project (3/26/2024).

Acknowledgements

This README structure was based on that within Nidhal Naffati's Rental-Car-Agency repository, which happened to use a very similar technology set as our project. The repository for this can be found here: Car Rental Agency.