Design
If you're looking for documentation, then be sure to read the wiki.
YouCanBenefit is a web application that increases social benefit program discoverability for people of lesser means and their allies. There are similiar projects, but where I think YouCanBenefit differs in at least some cases, is that it takes what the user likely knows -- their demographic information -- and compares against what the user likely has trouble finding -- the available social programs. It does not save user data.
Want to run the app? Setup is documented here. Maybe read some other parts of the wiki too.
screenerClient is the web client it is written in Angular/ One useful feature is the /admin module. It allows for an admin to configure elasticsearch from a gui.
api-server is the api that handles backend business logic and acts as an interface with elasticsearch.
utils are various utilities that can manage elasticsearch data. Used to seed -- create the database and put a test value in it -- download data or stream data from one elasticsearch instance to another.
developer quickstart hopefully a relatively simple set of instructions to start.
- read the wiki
- look at the issues:
- Refactor code into modules -- don't mess with implementation details just make modular.
- Break modules apart -- turn them into seperate npm modules.
- Test modules -- set expected code behavior
- refactor modules -- improve code quality
- document modules -- a diagram and a sentence or two
- combine modules -- combine modules into application
- Publish the code as npm modules.
- split the user and admin application into two different applications
- make the user application vanilla
- implement progressive web application features
- make the admin application a heavier
Angularapplication.
-
Production, development and test docker builds.