From 18a24fa41b41a316c4731e6bc9a18db7228f4004 Mon Sep 17 00:00:00 2001 From: Andrew Ho <87453706+anmho@users.noreply.github.com> Date: Tue, 6 Feb 2024 20:39:40 -0800 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 423f5594..62ea7c47 100644 --- a/README.md +++ b/README.md @@ -40,20 +40,22 @@ A summary of the libraries we use are listed below. 1. Clone the ZotMeal repository or your fork. `git clone https://github.com/icssc/ZotMeal.git` -2. Navigate to the root directory and install the dependencies. +2. Change your node version to the one specified in .nvmrc + `nvm use` +3. Navigate to the root directory and install the dependencies. `cd ZotMeal && pnpm install` +4. Create a .env based on the .env.example +5. To start a local Postgres container database run the `start-database.sh` script. This will automatically set a test database. +6. Run `turbo db:generate` -3. Start the local development servers for expo and server. +7. Start the local development servers for expo and server. `pnpm dev` The tRPC procedures are available on http://localhost:3000/?input={field: value} -4. Change your node version to the one specified in .nvmrc - `nvm use` - -5. View the local website at http://localhost:19006 and/or with the [Expo Go mobile app](https://expo.dev/client). +8. View the local website at http://localhost:19006 and/or with the [Expo Go mobile app](https://expo.dev/client). As you make changes to the Expo application, those changes will be automatically reflected on the local website as well as the mobile app. -6. To add a new package run `turbo gen workspace` and follow the prompts +9. To add a new package run `turbo gen workspace` and follow the prompts ## Testing Run `turbo test` at the root of the project.