Skip to content

Commit

Permalink
revise README files (#98)
Browse files Browse the repository at this point in the history
  • Loading branch information
jkoren authored Oct 19, 2023
1 parent bc7c70b commit 7c8b827
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,22 @@
## Teams

### UI/UX and/or Design

This team will work with the other teams to match the interface and necessary research together.

### Frontend

This team will plan and build the user interface. React and Remix in [Epic Stack](https://github.com/epicweb-dev/epic-stack). Uses Pyodide to run python code on frontend.
It will also get information from the weather station API that the rules engine can use for its calculations. In the future, it may work on permissions and persistence of household data.
It will also get information from the weather station API that the rules engine can use for its calculations. In the future, it may work on permissions and persistence of household data.

### Rules Engine

### Rules Engine
This team will help convert or read the existing spreadsheet logic into something the app can act upon. Uses numpy and Python: likely to run in-browser rather than on backend.

### Auth/Persistence

This team will determine the best way to allow users to store their past cases with the households they visit. Likely to use SQLite and Prisma in [Epic Stack](https://github.com/epicweb-dev/epic-stack).

### Installation

To install the front end, see this [README.md](https://github.com/codeforboston/home-energy-analysis-tool/blob/main/heat-stack/README.md)
1 change: 1 addition & 0 deletions heat-stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
```
git clone git@github.com:codeforboston/home-energy-analysis-tool.git
# create an environment file
cd heat-stack
cp .env.example .env
# make sure you're using node version 18
Expand Down

0 comments on commit 7c8b827

Please sign in to comment.