MyAwesomePOS is being built as a direct, lightweight and practical POS project. If you find it useful, you can support its development with a small contribution, either with a donation or by improving the base code of the repository.

Buy me a coffee Repository

How can I contribute to the code?

MyAwesomePOS is not only a website. It is part of a larger POS ecosystem built with a clear development workflow, so every contribution can be tested, reviewed and released without breaking the stable version used by real users.

01

Create your branch from dev

All contributions start from the dev branch. No one should work directly on dev. Create a dedicated branch using a clear prefix:

  • feature/name-of-change
  • fix/name-of-bug
  • test/name-of-test
02

Merge into dev after tests

Once the change is ready, it must be merged back into dev only after passing the required tests and checks. This keeps the development branch clean and avoids uncontrolled changes.

03

Promote to pre / beta

After being tested in dev, the change can move to pre. This branch works as the advanced version of the app, available for users who want to try new features before they become stable.

04

Release to main / stable

If the feature works well, behaves correctly and users are satisfied, it can be promoted to main. This branch represents the final stable version of MyAwesomePOS.

From idea to implementation

If you want to propose a new feature, improvement or technical change, follow the same workflow used by the project. The goal is simple: ideas should become code only after being structured, tested and validated.

Propose the idea and define the scope

Start by explaining the problem, who benefits from the feature and why it fits inside MyAwesomePOS. Then reduce the idea to a realistic first version: small enough to build, useful enough to matter.

Create a branch, build and test

Create a clean branch from dev, using a prefix such as feature/, fix/ or test/. Build the change, check that the project still works and add tests or documentation when needed.

Move and improve

Once validated, the contribution moves through the pipeline: dev, then pre, and finally main when it proves stable. After release, keep improving the feature with real feedback.

Current focus

Frontend documentation

Creating clear documentation for pages, components, styles, routing and deployment decisions.

Website polish

Improving visual consistency, responsive behavior, brutalist UI blocks and public-facing pages.

Project structure

Keeping the project organized so it can grow without becoming chaotic.

Translations

Translating the program into other languages to make it accessible to more users, businesses and developers.