From c5a0fc8f6824f0b9f42b76de7c9c6b3d4e46bf06 Mon Sep 17 00:00:00 2001 From: psychedelicious <4822129+psychedelicious@users.noreply.github.com> Date: Wed, 5 Oct 2022 07:58:32 +1100 Subject: [PATCH] Updates frontend README --- frontend/README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index 94934b2bce..f597cc6f23 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -2,24 +2,22 @@ ## Run -- `python backend/server.py` serves both frontend and backend at http://localhost:9090 +- `python scripts/dream.py --web` serves both frontend and backend at + http://localhost:9090 ## Evironment Install [node](https://nodejs.org/en/download/) (includes npm) and optionally [yarn](https://yarnpkg.com/getting-started/install). -From `frontend/` run `npm install` / `yarn install` to install the frontend packages. +From `frontend/` run `npm install` / `yarn install` to install the frontend +packages. ## Dev 1. From `frontend/`, run `npm dev` / `yarn dev` to start the dev server. -2. Note the address it starts up on (probably `http://localhost:5173/`). -3. Edit `backend/server.py`'s `additional_allowed_origins` to include this address, e.g. - `additional_allowed_origins = ['http://localhost:5173']`. -4. Leaving the dev server running, open a new terminal and go to the project root. -5. Run `python backend/server.py`. -6. Navigate to the dev server address e.g. `http://localhost:5173/`. +2. Run `python scripts/dream.py --web`. +3. Navigate to the dev server address e.g. `http://localhost:5173/`. To build for dev: `npm build-dev` / `yarn build-dev` @@ -28,10 +26,3 @@ To build for production: `npm build` / `yarn build` ## TODO - Search repo for "TODO" -- My one gripe with Chakra: no way to disable all animations right now and drop the dependence on - `framer-motion`. I would prefer to save the ~30kb on bundle and have zero animations. This is on - the Chakra roadmap. See https://github.com/chakra-ui/chakra-ui/pull/6368 for last discussion on - this. Need to check in on this issue periodically. -- Mobile friendly layout -- Proper image gallery/viewer/manager -- Help tooltips and such