create-t3-labrys

Installation

There are two ways of initializing an app using the create-t3-labrys starter. You can either use this repository as a template, or use Turbo's CLI to init your project (use PNPM as package manager):

npx create-turbo@latest -e https://github.com/Labrys-Group/create-t3-labrys

Documentation

Documentation is co-located with the code. Key documentation files:

• Project Overview: Main documentation index
• Project Structure: Monorepo organization
• App Documentation:
  • Next.js App
  • Expo App
• Package Documentation:
  • API Package
  • Database Package
  • UI Package

You can also visit the online documentation at https://create.labrys.io/ (if hosted).

Quick Start (Without Expo)

To get it running, follow the steps below:

1. Install Dependencies

# Install dependencies
pnpm i

# Configure environment variables
# There is an `.env.example` in the root directory you can use for reference
cp .env.example .env

2. Delete the Expo Project

rm -rf apps/expo

3. Run the Web App

cd apps/nextjs
pnpm dev

4a. When it's time to add a new (web) UI component

Run the ui-add script to add a new UI component using the interactive shadcn/ui CLI:

pnpm ui-add

When the component(s) has been installed, you should be good to go and start using it in your app.

4b. When it's time to add a new package

To add a new package, simply run pnpm turbo gen init in the monorepo root. This will prompt you for a package name as well as if you want to install any dependencies to the new package (of course you can also do this yourself later).

The generator sets up the package.json, tsconfig.json and a index.ts, as well as configures all the necessary configurations for tooling around your package such as formatting, linting and typechecking. When the package is created, you're ready to go build out the package.

Quick Start (With Expo)

To get it running, follow the steps below:

1. Setup dependencies

# Install dependencies
pnpm i

# Configure environment variables
# There is an `.env.example` in the root directory you can use for reference
cp .env.example .env

2. Configure Expo dev-script

Use iOS Simulator

1. Make sure you have XCode and XCommand Line Tools installed as shown on expo docs.

   NOTE: If you just installed XCode, or if you have updated it, you need to open the simulator manually once. Run npx expo start from apps/expo, and then enter I to launch Expo Go. After the manual launch, you can run pnpm dev in the root directory.

   +  "dev": "expo start --ios",

2. Run pnpm dev at the project root folder.

Use Android Emulator

1. Install Android Studio tools as shown on expo docs.

2. Change the dev script at apps/expo/package.json to open the Android emulator.

   +  "dev": "expo start --android",

3. Run pnpm dev at the project root folder.

4a. When it's time to add a new (web) UI component

Run the ui-add script to add a new UI component using the interactive shadcn/ui CLI:

pnpm ui-add

When the component(s) has been installed, you should be good to go and start using it in your app.

4b. When it's time to add a new package

To add a new package, simply run pnpm turbo gen init in the monorepo root. This will prompt you for a package name as well as if you want to install any dependencies to the new package (of course you can also do this yourself later).

The generator sets up the package.json, tsconfig.json and a index.ts, as well as configures all the necessary configurations for tooling around your package such as formatting, linting and typechecking. When the package is created, you're ready to go build out the package.