Merge pull request #173 from CodeForPhilly/pcabe-cleanup-library-api

Cleanup library api

Author: prestoncabe

library-api/.idx/default-vscode-settings.jsonc

@@ -1,69 +1,18 @@
-# DMN Library
+# Library API
 
-## Note: this directory was originally at the top level of the project and represented the entirety of the project. We've begun developing a web app for use as a development environment for screenings and their specific DMN rules. The future of this `dmn-library` directory is for it to morph into simply the place where "library" DMN is developed and tested. This means DMN that can be included/reused in a variety of screeners, not just particular to one screener. When we are able to fully deploy existing screeners using the new web app, then facilities for deploying screeners and the API from this library directory will be removed.
+## What is this?
 
-## Setup a Development Environment
+What is now called `library-api` is what used to be at the top-level of this project. It contains a Quarkus application that still serves the [Philly Property Tax Relief Screener](https://phillypropertytaxrelief.org), the example [PACE Screener](https://phillypropertytaxrelief.org/pace), and the [Eligibility API](https://phillypropertytaxrelief.org/q/swagger-ui) that backs both of these screeners. The API is generated from the DMN models in `src/main/resources/`.
 
-Since the ultimate goal of this project is to enable a development environment that is accessible to those without a software engineering background, we are intrigued by tools like [Firebase Studio](https://firebase.google.com/docs/studio) as a precursor/mockup for a more specialized service that we'd like to build (eventually).
+## What do we want this to be?
 
-With Firebase Studio, the environment is in the cloud, and can be accessed from any computer without any manual setup.
+We're not exactly sure, but we see the DMN models here as the proof-of-concept for a "library" of benefits and eligibility rules. We are in the process of creating a tool that will streamline the creation of screeners (the prototype of which you'll find in the `builder-frontend/` and `builder-api` modules of this project) and we imagine know that we'll want users of the builder to have access to some sort of rules library.
 
-If you're an experienced engineer, however, you may want to skip Firebase Studio in favor of your own preferred setup. (Up to you.)
+So `library-api` will evolve as we figure out the new builder tools. And we'll likely remove the screener code here as the builder is able to replace it.
 
-### Use Firebase Studio (simplest)
+## Kicking the tires
 
-The easiest way to get a feel for Benefit Decision Toolkit is to [fork this repo*](https://github.com/CodeForPhilly/benefit-decision-toolkit/fork) and then open it (from the fork!) in Firebase Studio:
-
-<a href="https://studio.firebase.google.com/import?url=https%3A%2F%2Fgithub.com%2FCodeForPhilly%2Fbenefit-decision-toolkit">
-  <picture>
-    <source
-      media="(prefers-color-scheme: dark)"
-      srcset="https://cdn.firebasestudio.dev/btn/open_dark_32.svg">
-    <source
-      media="(prefers-color-scheme: light)"
-      srcset="https://cdn.firebasestudio.dev/btn/open_light_32.svg">
-    <img
-      height="32"
-      alt="Open in Firebase Studio"
-      src="https://cdn.firebasestudio.dev/btn/open_blue_32.svg">
-  </picture>
-</a>
-
-When you open Benefit Decision Toolkit in Firebase Studio, a development machine will be created and configured for you in the cloud. (This will take a few minutes.)
-
-After the first time you open the project, you can just return to https://studio.firebase.google.com   to pick up where you left off.
-
-_*Note on forking: you can skip this step if you are just curious or otherwise don't intend to contribute changes back to the project._
-
-### Use Devbox (medium simple)
-
-The second easiest way to get started is to [fork this repo*](https://github.com/CodeForPhilly/benefit-decision-toolkit/fork), clone it to your local machine, and use the included Devbox configuration:
-
-[![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)
-
-[Devbox](https://www.jetify.com/devbox) is a way to create isolated development environments on your own machine.
-
-We're experimenting w/ Devbox for the same reason we're experimenting w/ Firebase Studio; we're interested in how this approach to managing development environments could form the basis of some future specialized/packaged toolkit.
-
-### Roll your own (for experienced developers)
-
-Of course, you can also manually setup a laptop/desktop to work on Benefit Decision Toolkit, but it isn't recommended unless you really know what you're doing.
-
-### Additional setup notes
-
-#### Forms development
-
-If you're planning to develop forms (the basis of eligibility screeners) in addition to eligibility rules, then you'll also need to download [Camunda Modeler](https://camunda.com/download/modeler/).
-
-#### Kicking the tires and testing your work
-
-You can run `bin/dev`* from a terminal to start the Quarkus development server. This will serve the API and any existing eligibility screeners from `https://localhost:8080`**.
-
-*_If you are using Firebase Studio the Quarkus dev server should automatically start when you load the workspace._
-
-**_Since Firebase Studio is a browser-based environment, the system will map the URL for the dev server to an address you can reach from a browser in your local machine. You can access this address by clicking on the Firebase Studio logo in the left sidebar, then clicking into the "Backend Ports" panel._
-
-<img src="docs/images/backend-ports.png" width=600 alt="Screenshot of Backend Ports list in Firebase Studio">
+If you want to play with the example screeners and/or API yourself, you can follow the Development Setup instructions in the root README, then run `bin/dev` from this directory to start the Quarkus development server. This will serve the API and any existing eligibility screeners from `https://localhost:8083` by default.
 
 ## Technologies overview