2.6 KiB
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
- Runtime: Bun
- Linter: Biome
- Framework: TanStack Router
- Database: Drizzle ORM
- Components: shadcn/ui
- Form: React Hook Form
- State Management: TanStack Query
- i18n: Inlang
- Email Templating: React Email
Development
From your terminal:
bun i
bun run --bun dev
This starts your app in development mode, rebuilding assets on file changes.
Setup
This application will only run under the bun runtime, if you wish to run it under anything else you will have to replace parts of it, if you do not have it installed yet you can do it here. While the application can maybe run on Windows it's still recommended to use WSL and support will only be given for WSL or Linux.
Only properly formatted code will be accepted, please do not add any CSS use Tailwind when needed, this project aims to be barebones and be as reusable as possible.
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 on docker or use another SMTP test server.
IDE
It is recommended to use VSCode, the following extensions will help you:
- Linter: biomejs.biome
- Typescript Server: ms-vscode.vscode-typescript-next
- Easier i18n: inlang.vs-code-extension
- TODO list: gruntfuggly.todo-tree
- Tailwind IntelliSense: bradlc.vscode-tailwindcss