Code Monkey home page Code Monkey logo

group-project-a's Introduction

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

group-project-a's People

Contributors

ahmedburale avatar mouzong avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

group-project-a's Issues

GPA-11 As As a developer, I want to create a README.md file that provides an overview of the project, its purpose, and how to set it up and run it.

  • Document the project's architecture and design
  • Create UML diagrams, that depict the different components and their interactions
  • Create API documentation that outlines the endpoints and their expected inputs and outputs, including any authentication or authorization requirements
  • Document any external dependencies or libraries used in the project, including version numbers and any configuration or setup instructions.
  • Provide information on how to run tests and ensure that the project meets the required quality standards.
  • Provide troubleshooting guides and known issues in the documentation, so that future developers can quickly resolve any issues that may arise.
  • Provide contribution guidelines for all contributors

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.