https://github.com/amigoscode/group-project-a
https://github.com/amigoscode/group-project-a
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/amigoscode/group-project-a
- Owner: amigoscode
- License: mit
- Created: 2023-02-23T09:38:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-10T18:46:19.000Z (almost 3 years ago)
- Last Synced: 2025-02-01T03:42:29.233Z (about 1 year ago)
- Language: Java
- Size: 282 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of contents
=================
- [Table of contents](#table-of-contents)
- [Overview](#overview-a-nameoverview-a)
- [Installation](#installation-a-nameinstallation-a)
- [Requirements](#requirements-a-namerequirements-a)
- [Usage](#usage-a-nameusage-a)
- [Repo-Content](#repo-content-a-namerepo-content-a)
- [.github](#--github-a-namegithub-a)
- [design](#--design-a-namedesign-a)
- [database](#--database)
- [infrastructure](#--infrastructure)
- [docs](#--docs-a-namedocs-a)
- [scripts](#--scripts-a-namescripts-a)
- [src](#--src-a-namesrc-a)
- [src/main](#--srcmain-a-namesrcmain-a)
- [src/main](#--srctest-a-namesrctest-a)
- [Contribution](#contribution-a-namerepo-content-a)
- [Branching-Strategy](#--branching-strategy-a-namebranching-strategy-a)
- [Peer-Contribution](#peer-contribution)
- [Credit](#--credit-a-namecredit-a)
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 :
### - design
#### - database
#### - infrastructure
### - src
#### - src/main
##### - config
##### - controllers
##### - db
##### - dto
##### - email
##### - exceptions
##### - models
##### - repository
##### - services
##### - shared
##### - utils
##### - BudgetTracker
## - 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
- Ahmed BURALE catabilar@gmail.com
- Andreas MOUZONG andreasmouzong@gmail.com