LyonKhang / onwardfrontend

0 stars 2 forks source link

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.

This is a front end part

Technologies Used

The following technologies were used to build this application:

WorkLoad

The following Workload was used in Visual Studio 2022 installer

Requirements

You need Visual Studio 2022 before doing other steps and updates to the current version Follow the step for Visual Studio 2022 from Microsoft's website

1.Having Microsoft .NET Maui Framework for the Front end.
Follow the step for Microsoft .NET Maui from Microsoft's website

2.Having Android SDK platform by Xamarin. Follow the step in Microsoft's website.

NuGet

Addtional Nuget packages can be found on Project task Bar label as "Manage NuGet Packages". You can dowload it right on Visual Studio or visit the follwing website for guide.

  1. Having Microsoft.Maui.Controls(8.0.21) a cross-platform framework for C# ,XAML, and runs such as Android, iOS, macOS, Tizen, and Windows from a single shared codebase.nuget.org's website

  2. Having Microsoft.Maui.Controls.Compatibility(8.0.21) a APIs and views that allow for easier migration from Xamarin.Forms.nuget.org's website

  3. Having Microsoft.Extensions.Logging.Debug(8.0.0) Debug output logger provider implementation .nuget.org's website

  4. Having Microsoft.Maui.Essentials(8.0.21) collection of cross-platform APIs for working with device sensors and other features.nuget.org's website

  5. Having Microsoft.NET.ILLink.Tasks(8.0.4) tell where to reference by an SDK.nuget.org's website

  6. Having Newtonsoft.Json(13.0.3) a high-performance JSON framework for . NET.nuget.org's website

Installation

  1. Clone this repository to your local machine using this command:
    git clone https://github.com/LyonKhang/onward.git Or Import the project from your IDE (Visual Studio 2022).
  2. On File > Open > Project/Solution
  3. Choose ONWaRD05.csproj
  4. Click run as perfer operating system. *If it appears an app running. You have successfully compiled the project

Architecture

Frontend

Development Environment

Integration and Data Management

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 (4/2/2024).

Acknowledgements

This is a modified version based on ONWaRD. Vinh is the original modified of this version. 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.