Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bjsilva1 authored Jan 14, 2025
1 parent ba55b2f commit abbf130
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,27 +65,30 @@ 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. Change your node version to the one specified in .nvmrc
`nvm use` or `fnm use`
3. Navigate to the root directory and install the dependencies.
2. Download the correct version of node.
`nvm install 20.12.1` or `fnm install 20.12.1`

3. Change your node version
`nvm use 20.12.1` or `fnm use 20.12.1`
4. Navigate to the root directory and install the dependencies.
`cd ZotMeal && pnpm install`

4. To start a local Postgres container database run the `docker compose up` in the root directory.
5. To start a local Postgres container database run the `docker compose up` in the root directory.
This will automatically set up and run a test database using docker.

5. Create a .env based on the example given in `.env.development`
6. Create a .env based on the example given in `.env.development`

6. Run `pnpm db:push` to push the schema to the docker database.
7. Run `pnpm db:push` to push the schema to the docker database.

7. Start local development by running `pnpm dev` in `/apps/expo` and `pnpm dev` in `/apps/server` (or `turbo dev` in the root directory).
8. Start local development by running `pnpm dev` in `/apps/expo` and `pnpm dev` in `/apps/server` (or `turbo dev` in the root directory).
The tRPC procedures are available on <http://localhost:3000/><router.procedure\>?input={field: value}

```sh
# example
http://localhost:3000/events.get
```

8. View the local website at <http://localhost:8081> and/or with the [Expo Go mobile app](https://expo.dev/client).
9. View the local website at <http://localhost:8081> 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.

Expand Down

0 comments on commit abbf130

Please sign in to comment.