web.ts/README.md

34 lines
1.2 KiB
Markdown

> [!IMPORTANT]
> This app is in development, very incomplete and just a starting point for a PostgreSQL server transition.
# Web.TS
This app is built with the following technologies
- 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
bun i
bun run --bun dev
```
This starts your app in development mode, rebuilding assets on file changes.
## Setup
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.
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.
If you wish to experiment with the email bits I recommend setting up something such as [MailCrab](https://github.com/tweedegolf/mailcrab) on docker or use another SMTP test server.