Skip to content

Latest commit

 

History

History
111 lines (68 loc) · 4.1 KB

README.md

File metadata and controls

111 lines (68 loc) · 4.1 KB
Raw

Bar API

This project is an api-application is an api for the use in our bar-application project. It is supposed to help bar-application keep track of the drinks that they sell to customers. It will be capable of the following:

  • Managing drinks and their prices
  • Managing customers and their bills
  • Managing the payments off the customers to the bartender
  • ... and more

Possibly will be capable of:

  • Logging in with different roles
  • See insight information about your bill (customer)
  • See which drinks need to be restocked

This project is made for Bart's Bar, a local bar in Harmelen, The Netherlands.

Table of Contents

Domain

image

Release

The current build can be found on Expo here

We are working on an iOS and Android release soon.

Tools

This project is made with Spring - Java. It allows us to easily build an API.

Git Strategy

For our git strategy, we are using a modified version of git flow. In our strategy we use the following branches:

  • Master branch
  • Development branch
  • Feature branches

Whatever is in the master branch, will be running on the latest build. The only things that will go in the master branch are releases, accompanied by git tag tags (v1, v2, etc.).

All of the development work will be done in the development branch. This is to ensure that the deployed version (master branch) will always remain stable.

For every story or (sub)task we create a new feature branch, each team member can do whatever he wants in this branch (rebasing, force pushing, all of it). These feature branches will be used to make Pull Requests in Github. In these PR's there will be regular reviews to ensure high code quality.

Scrum

This project will make use of the Agile workflow, implementing the Scrum method. This can be seen from our project board.

Currently we use the following lanes:

  • Backlog
  • To Do
  • In progress
  • Done (automated)

We have added all the different types of User Stories located in our backlog. This way, we can assign different team members to the sub tasks.

Contributing

We are always open to any contributors wanting to help us out with the project. In this section you will find some information on how you should approach it.

Coding standards

In this project we make use of a free to use Visual Studio Code extension called: Prettier. It handles code formatting for us. When installed it automaticly detects a prettier file sitting in the root of the project. This will make sure the code is formatted the same across all contributors.

Git

Commits

To keep your commits clean, we follow the advice given in this article.

History

To keep the Git history as clean as possible we do not allow merging between feature brances. Instead we use git rebase for this. All merging is to be done from Github.

Feature Branches

For every issue on the project board you can create a branch. This branch must follow the feature branch naming convention like this:

feature/{isssue code}-a-small-description

This makes sure that we can always discern branches from eachother. For example:

feature/22-topbar-menu-implementation

Pull requests

After you have finished an issue and the feature branch is ready to be merged with development you create a new pull request by going to:

Github -> bar-application -> Pull requests -> Compare and create new pull request

In your last commit you must say to Github that the issue is done and it may close it. You can do this by typing: Closes #{feature id} inside your commit message. Example:

Closes #22