https://github.com/nishan9/travelx-api

Backend of TravelX
https://github.com/nishan9/travelx-api

azure-app-service java-11 maven spring-boot

Last synced: 26 days ago
JSON representation

Backend of TravelX

• Host: GitHub
• URL: https://github.com/nishan9/travelx-api
• Owner: nishan9
• Created: 2023-07-31T20:43:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-18T08:54:14.000Z (about 1 year ago)
• Last Synced: 2024-10-13T04:03:10.611Z (26 days ago)
• Topics: azure-app-service, java-11, maven, spring-boot
• Language: Java
• Homepage:
• Size: 41.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 69
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




 GetYourWay API 🛬 



[![Unit Tests](https://github.com/nishan9/TravelX-API/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/nishan9/TravelX-API/actions/workflows/unit_tests.yml) [![Build and Deploy to Azure ](https://github.com/nishan9/TravelX-API/actions/workflows/deploy_to_azure.yml/badge.svg)](https://github.com/nishan9/TravelX-API/actions/workflows/deploy_to_azure.yml)

# 🛠️ Installation

Before running the application. 

1. Login to the azure portal. 

2. Go to the network tab in the SQL Server instance and add your IPv4 address, so you can connect to the server from your device. 

Run the application via `./mvnw spring-boot:run` in the home directory.

# 🔐 Authorisation Flow

The following diagram shows how the application authorisation flow works:

![Authorisation Flow](/.eraser/FZOdoDP7gyF1Ceo5SjWs___U6y9emfrl8eHDv3I72P3GpFUUJa2___---figure---oBjVNl6M2yDtFaNPqBlnO---figure---vhnfp7DaSoydBvnDKtHlhg.png "Authorisation Flow")

# 🗂️ Entity Relationship Diagram

![ERD](/.eraser/FZOdoDP7gyF1Ceo5SjWs___U6y9emfrl8eHDv3I72P3GpFUUJa2___---figure---_YqrANLAr1CktGtRRJqcj---figure---RrGZRELgTlsSRVsgyxw5mw.png "ERD")

# 🤝 Contributions

To follow the feature branch workflow, create a new branch with the following.

Ensure you are in front of the dev branch to minimise the risk of conflicts: 

```

git pull origin dev

```

Ensure there is a `.gitignore` file so your target folder is not pushed. 

Create a new branch with an appropriate name of the feature you are working on:

```

git checkout -b feature/name

```

After each session or sufficicient changes. 

```

git add .

git commit -m "Commit Message"

```

Once you are ready with your feature pull the latest dev branch. 

```

git checkout dev

git pull origin dev

```

Go back to your own branch and merge dev into your own branch. 

```

git checkout feature/name

git merge dev

```

If there are conflicts please resolve them. 

Once resolved, Login to Github and create a pull request and wait for someone to review it. Once reviewed your branch will be merged into dev.