Skip to content

Commit

Permalink
fix: refine README to reflect current state
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianmcphee committed Nov 21, 2024
1 parent 4250699 commit 82f8543
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,23 @@ This is the platform that powers OpenUnited. [Apps](https://docs.djangoproject.c

Capabilities:

- Product Management (Product, Capability, Initiative, Challenge, Bounty etc.)
- Product Management (Product, Product Tree / Product Area, Initiative, Challenge, Bounty etc.)
- Talent (Person, Skill, BountyClaim etc.)
- Commerce (Organisation, Points & Payments etc.)
- Commerce (Organisation, Accounts,Points & Payments etc.)
- Engagement (Notifications etc.)
- Security (Role-based access control etc.)

Other apps:

- Event Hub (Event Bus)
- Portal (UI for Management of Org, Products, Challenges, Bounties etc)
- Challenge Authoring Flow (UI and services for authoring challenges)

The apps aspire to be loosely coupled, and we use a service layer between views and models. Services are also used to communicate across the boudaries of apps. This approach also allows us to use mocks to test the services effectively.
The combination of being a marketplace of different personas and many new concepts and processes makes this a rather complex domain. The separation provided by apps is a simple mechanism to have boundaries without unnecessary complexity so we can predictably evolve the platform and create value rapidly.

This repo contains the full platform including the frontend - which is deliberately simple. We use a mix of TailwindCSS, DaisyUI and a mix of HTMX, AlpineJS and reluctantly JQuery where it makes sense. We favour frontend simplicity and server side rendering using django templates where possible. Over time we may rewrite some things in ReactJS, but for now that's overkill and the focus is on evolving the platform to create value and getting mileage out of the most simple frontend tech possible to deliver excellent UX.
The apps aspire to be loosely coupled, and we use a service layer between views and models. Services are also used to communicate across the boudaries of apps. This approach also allows us to use mocks to test the services effectively. Done is better than perfect, so you will find cases where this is (not yet) the case.

This repo contains the full platform including the frontend - which is deliberately simple. We use a mix of TailwindCSS, DaisyUI and a mix of HTMX, AlpineJS and reluctantly JQuery where it makes sense. We favour frontend simplicity and server-side rendering using django templates where possible. Over time we may rewrite some things in a fancier frontend stack or create mobile apps, but for now that's overkill and the focus is on evolving the platform to create value and getting mileage out of the most simple frontend tech possible to deliver excellent UX. The approach of having well-defined services, and thin views, makes evolving the frontend stack relatively simple.

## Setting up The Project and Contributing

Expand Down

0 comments on commit 82f8543

Please sign in to comment.