mrmatil / kurierex

Kurierex

Table of Contents

• About the Project
  • Built With
  • Functionalities
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Frontend

About The Project

This is API for Kurierex Project, which enables users to calculate package sending cost with its dimensions.

Built With

• Java
• Spring Boot
• Firebase

Functionalities

This API is responsible for functionalities such as:

• Calculating package cost with given dimensions
• Sending data to firebase realtime database (both package dimensions and sender+receiver contact details)

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

• IDE
• Browser

Installation

For Local

1. Clone the repo

https://github.com/mrmatil/kurierex

Usage

For usage examples please refer to the Live Documentation in API

Frontend

• Github: https://github.com/sobusz/KurierexAngular