Skip to content

Latest commit

 

History

History
107 lines (84 loc) · 3.63 KB

README.md

File metadata and controls

107 lines (84 loc) · 3.63 KB
Raw

Table of contents

Overview

Repository /amigoscode/group-project-a Contains directories and files which are need in the Budget Tracker App for:

  1. Configuration of the deployment server and CI/CD workflows
  2. Front-end part of the application
  3. Backend API files of the application

Installation

Requirements

  1. Java 17
  2. Maven
  3. Springboot V3
  4. PostgreSQL
  5. Angular
  6. Node.js

Usage

Local .

  1. Clone the repository in to your local computer

Online

  1. Head over to your browser and follow the link :

Repo-Content

- .github

- design

- database

- infrastructure

- docs

- scripts

- src

- src/main

- config
- controllers
- db
- dto
- email
- exceptions
- models
- repository
- services
- shared
- utils
- BudgetTracker

- src/test

- LICENCE

- pom.xml

- README.md

- Contribution

- Branching-Strategy

The project is composed of Three main branches:

  • main : The production branch
  • release : Branch for every release of the products
  • develop : Development branch for contribution and consolidation before release

There a re side branches used for adding features and linked to issues in the backlog (feature/GPA-01). The naming convention of the branches is based on the project name Goup A and the issue number. For example feature/GPA-01 branch, we refer to:

  • GPA: Group A
  • 01: Issue number

- Peer-Contribution

For any external contribution and collaboration on the project, you need to proceed as follows:

  • Clone/fork the repository
  • Create a branch after your changes (feature/GPA-05-support)
  • Pull latest changes from the develop branch on master repo
  • Commit your changes and open a pull request on the develop branch

- Credit