Design Docs
pedro-psb opened this issue · comments
Introduction
Pypos is a Point of Sale SaaS system aimed to be easly implemented in a small scholar canteen, where most clients are financially dependent of their parents and where clients are usually recurrent.
The system is aimed to be lightweight, with an account system for cashless payment, basics but insighfull financial registering/ reporting and an offline support.
Context
My girlfriend started working on a canteen with absolutely no structure. There was no Point of Sale or Cash Flow software (not even a notebook!) and the manager wanted to allow sales on credit, which was quickly becaming a big mess. Also, there was no budget to hire a ready solution, so my girlfriend was suffering, and I wanted to do something to help.
At the time this happened, I was in early stages of webdev and programming learning, so the best I could do was an Airtable to manage mainly the sales on credit, but still, the connection there was poor and sometimes the system let them down. During this period I dived into this problem, but didn't had the tools to build it.
Now, even she doesn't work there anymore, I wanted to build this system I though about so much for the sake of adressing someone who is going through this problem, and also as a tool for learning the tools and trades of web developemnt and project management.
Goals and Non Goals:
The system aims to:
- Let the sales quickly record transactions in the POS interface with little effort.
- Manage credit sales with ease and little burocracy. The system are aimed for small business, there is some trust involved.
- Display simple and solid financial and client habits reports/insights.
- Be a small sized SaaS
- Be a learning-project for myself
The system doesn't aims to:
- Be extremely scalable
- Be a complete ERP or financial manager.
The Design
The app is build with Flask and aimed to be deployed within docker containers as a SaaS.
I may do a self-host build afterwards.
System Context
TODO
APIs
TODO
Data Storage
TODO
Alternative consideration
TODO
Cross-cutting Concerns
TODO