Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.77 KB

README.md

File metadata and controls

71 lines (47 loc) · 2.77 KB
Raw

ZotMeal

About

ZotMeal is a cross-platform React Native Expo application. A summary of the libraries we use are listed below.

Technology

Web/Mobile Application

  • Expo - Universal framework for React Native.
  • Tamagui - UI component library for React Native.
  • Serverless Framework - Framework for cloud resources such as AWS Lambda.
  • tRPC - Typesafe RPCs.

Getting Started

Pre-requisites

  1. Install Node.js. This allows you to run JavaScript on your computer (outside of a browser). This is best done with a version manager that allows you to easily switch between Node.js versions based on the requirements of different projects. Try using any of the following.

    If none of those work for any reason, you can defer to your Operating System's package manager or the downloads from the official website. We will be using the latest LTS version, 20.10.0, lts/iron.

  2. Install pnpm. This is our package manager of choice for this project. It's responsible for installing, uninstalling, and keeping track of the app's dependencies. npm install --global pnpm

  3. Make sure to have docker installed, which will allow you to run the local postgres database required for backend functions. You can install it from the official website here.

Developing

  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

  3. 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. 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. Run pnpm db:push to push the schema to the docker database.

  7. Start the local development servers for expo and server with pnpm dev. The tRPC procedures are available on http://localhost:3000/<router.procedure>?input={field: value}

  8. View the local website at http://localhost:8081 and/or with the Expo Go mobile app. As you make changes to the Expo application, those changes will be automatically reflected on the local website as well as the mobile app.

Testing

Run turbo test at the root of the project.

Adding Workspaces

To add a new package run turbo gen workspace and follow the prompts