WildEgo/web.ts
WildEgo/web.ts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update: README.md

Browse Source
This commit is contained in:
WildEgo 2025-06-06 00:10:56 +01:00
parent fe465982ad
commit 44b826a741
1 changed files with 16 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -1,72 +1,31 @@
# Welcome to TanStack.com!
> [!IMPORTANT]
> This app is in development, very incomplete and just a starting point for a PostgreSQL server transition.
This site is built with TanStack Router!
# Web.TS
- [TanStack Router Docs](https://tanstack.com/router)
This app is built with the following technologies
It's deployed automagically with Netlify!
- [Netlify](https://netlify.com/)
- Framework: [TanStack Router](https://tanstack.com/router/latest/docs)
- Database: [Drizzle ORM](https://orm.drizzle.team/docs)
- Components: [shadcn/ui](https://ui.shadcn.com/docs)
- Form: [React Hook Form](https://react-hook-form.com/docs)
- State Management: [TanStack Query](https://tanstack.com/query/latest/docs)
- i18n: [Inlang](https://inlang.com/)
- Email Templating: [React Email](https://react.email/docs)
## Development
From your terminal:
```sh
pnpm install
pnpm dev
bun i
bun run --bun dev
```
This starts your app in development mode, rebuilding assets on file changes.
## Editing and previewing the docs of TanStack projects locally
## Setup
The documentations for all TanStack projects except for `React Charts` are hosted on [https://tanstack.com](https://tanstack.com), powered by this TanStack Router app.
In production, the markdown doc pages are fetched from the GitHub repos of the projects, but in development they are read from the local file system.
Manually boot up a PostgreSQL instance, manually run the migrations under the `drizzle` directory, set the `.env` variables and you should be good to go.
Follow these steps if you want to edit the doc pages of a project (in these steps we'll assume it's [`TanStack/form`](https://github.com/tanstack/form)) and preview them locally :
1. Create a new directory called `tanstack`.
```sh
mkdir tanstack
```
2. Enter the directory and clone this repo and the repo of the project there.
```sh
cd tanstack
git clone git@github.com:TanStack/tanstack.com.git
git clone git@github.com:TanStack/form.git
```
> [!NOTE]
> Your `tanstack` directory should look like this:
>
> ```
> tanstack/
> |
> +-- form/
> |
> +-- tanstack.com/
> ```
> [!WARNING]
> Make sure the name of the directory in your local file system matches the name of the project's repo. For example, `tanstack/form` must be cloned into `form` (this is the default) instead of `some-other-name`, because that way, the doc pages won't be found.
3. Enter the `tanstack/tanstack.com` directory, install the dependencies and run the app in dev mode:
```sh
cd tanstack.com
pnpm i
# The app will run on https://localhost:3000 by default
pnpm dev
```
4. Now you can visit http://localhost:3000/form/latest/docs/overview in the browser and see the changes you make in `tanstack/form/docs`.
> [!NOTE]
> The updated pages need to be manually reloaded in the browser.
> [!WARNING]
> You will need to update the `docs/config.json` file (in the project's repo) if you add a new doc page!
Set the `STORAGE` enviroment variables even tho the integration is not done they're validated, make sure `STORAGE_ENDPOINT` is an url, there is no need to be valid.