From 4109814dd437559d476efd47350b8ac3e221d192 Mon Sep 17 00:00:00 2001 From: Andrew Bierman Date: Wed, 10 Apr 2024 21:17:02 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20adding=20vite=20docs=20to=20read?= =?UTF-8?q?me?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3e3b41485..275909788 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ So pack your bags, grab your friends, and get ready for your next adventure with - [Local installation 📲](#local-installation-) - [Dependencies](#dependencies) - [Environment Setup](#environment-setup) - - [Automated Setup 🛠️](#automated-setup-️) + - [Automated Setup (Unix) 🛠️](#automated-setup-unix-️) - [Manual Setup 📝](#manual-setup-) - [Yarn Setup](#yarn-setup) - [Root](#root) @@ -146,6 +146,7 @@ The main folders are: - `apps` - `expo` (native) - `next` (web) -- ssr not yet implemented + - `vite` (web) - `tauri` (desktop) -- not yet implemented - `packages` shared packages across apps @@ -245,7 +246,7 @@ cd PackRat - If you have access to the development env files, use those. Otherwise, replace the values with your own. - See the `.env.example` files in the `apps/expo` and `server` directories for the necessary environment variables. -#### Automated Setup 🛠️ +#### Automated Setup (Unix) 🛠️ 1. Run the setup script from the `PackRat` directory. ``` @@ -253,6 +254,7 @@ yarn setup ``` #### Manual Setup 📝 +- Note, if automated set up works the following manual config is taken care of already. 1. Navigate to the `PackRat` directory if you are not already there. @@ -319,7 +321,7 @@ cp gradle.properties.example gradle.properties cd ../.. ``` -9. Navigate to the `next` directory. +9. Navigate to one of the client directories such as `next`, `expo`, `vite`. ``` cd apps/next @@ -386,6 +388,10 @@ yarn start #### Client +- Note, we have a few options for running the client. + - For native we support both iOS and Android. You can run the app on either platform. Additionally, we support MacOS, Linux, and Windows for the desktop app with Tauri. + - For web, we are using Next.js for server-side rendering. (This is not yet implemented.) We also have a Vite build that provides a faster development experience. + 1. Navigate to the `expo` directory. ``` @@ -407,7 +413,13 @@ yarn run android cd apps/next ``` -3. Start the Expo/Next server. +3. Navigate to the `vite` directory. + +``` +cd apps/vite +``` + +4. Start the Expo/Next/Vite server. ``` yarn start