Open History to see the last commit
1# Contributing
2
3- Clone the repo
4 - `gh repo clone TanStack/create-tsrouter-app`
5- Ensure `node` is installed
6 - https://nodejs.org/en/
7- Ensure `pnpm` is installed
8 - https://pnpm.io/installation
9 - Why? We use `pnpm` to manage workspace dependencies. It's easily the best monorepo/workspace experience available as of when this was written.
10- Install dependencies
11 - `pnpm install`
12 - This installs dependencies for all of the packages in the monorepo, even examples!
13 - Dependencies inside of the packages and examples are automatically linked together as local/dynamic dependencies.
14- Run the build
15 - `pnpm build`
16- Build an example app with the builder:
17 - `node [root of the monorepo]/cli/create-tsrouter-app/dist/index.js app-js`
18 - Do not attempt to build an app within the monorepo because the dependencies will be hoisted into the monorepo.
19- Run `pnpm dev` at that top level to build everything in watch mode
20- Run `pnpm build` and `pnpm test` to make sure the changes work
21- Check your work and PR
22
23# Testing Add-ons and Starters
24
25Create the add-on or starter using the CLI. Then serve it locally from the project directory using `npx static-server`.
26
27Then, when creating apps with add-ons:
28
29```bash
30node [root of the monorepo]/cli/create-tsrouter-app/dist/index.js app-js --add-ons http://localhost:9080/add-on.json
31```
32
33And when creating apps with a starter:
34
35```bash
36node [root of the monorepo]/cli/create-tsrouter-app/dist/index.js app-js --starter http://localhost:9080/starter.json
37```
38
39# Developing on the CTA UI
40
41The CTA UI is somewhat tricky to develop on because it's both a web server and a React app. You need to run the CLI in "API" model and then the React app in dev mode, as well as the whole monorepo in watch mode.
42
43## Starting the API Server
44
45Let's start off with how to run the CLI in "API" mode. Here we are running the CLI in an empty directory in app creation mode.
46
47```bash
48CTA_DISABLE_UI=true node ../create-tsrouter-app/cli/create-tsrouter-app/dist/index.js --ui
49```
50
51If this is working you will see the following output:
52
53```
54Create TanStack API is running on http://localhost:8080
55```
56
57Note that it say "Create TanStack **API**" and not "Create TanStack **App**". This is important. This means that the CLI is providing API endpoints, but **not** serving the static build files of the React app.
58
59Here is the same command for the `add` mode:
60
61```bash
62CTA_DISABLE_UI=true node ../create-tsrouter-app/cli/create-tsrouter-app/dist/index.js add --ui
63```
64
65## Starting the React App
66
67Now that we have the API server running, we can start the React app in dev mode.
68
69```bash
70cd packages/cta-ui
71pnpm dev:ui
72```
73
74Navigate to `http://localhost:3000` and see the React app connected to the API server on `http://localhost:8080`.
75
76## Running the Monorepo in Watch Mode
77
78At the top level of the monorepo, run the following command to start the build in watch mode.
79
80```bash
81pnpm dev
82```
83
84This will build the monorepo and watch for changes in any of the libraries. (It will **not** build changes for the React app within the `cta-ui` package.)
85
86This is important because you might need to change API endpoints in the CTA library, or in the engine. If you do make those kinds of changes then the you will need to re-run the CLI in "API" mode to pick up the changes.