From 31573ad60d85117d4d1166bfde7a55729b873298 Mon Sep 17 00:00:00 2001 From: jkoren Date: Wed, 18 Oct 2023 21:49:59 -0400 Subject: [PATCH] revise README files --- README.md | 9 +++++++-- heat-stack/README.md | 1 + 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f09452e6..f5679127 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/heat-stack/README.md b/heat-stack/README.md index fabe59d7..a63d17af 100644 --- a/heat-stack/README.md +++ b/heat-stack/README.md @@ -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