Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 adding vite docs to readme #831

Merged
merged 1 commit into from
Apr 11, 2024
Merged

📝 adding vite docs to readme #831

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -245,14 +246,15 @@ 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.
```
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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

```
Expand All @@ -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
Expand Down
Loading