From 5ffb4d68a8f5b7f1444a88cf93fe4de5f9524313 Mon Sep 17 00:00:00 2001 From: WildEgo Date: Fri, 6 Jun 2025 00:40:31 +0100 Subject: [PATCH] add: Missing README.md information. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 7079c3d..7292502 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ This app is built with the following technologies +- Runtime: [Bun](https://bun.sh/docs) +- Linter: [Biome](https://biomejs.dev/) - 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) @@ -26,8 +28,22 @@ 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](https://bun.sh/docs/installation). While the application can maybe run on Windows it's still recommended to use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) 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](https://github.com/tweedegolf/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](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) +- Typescript Server: [ms-vscode.vscode-typescript-next](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-next) +- Easier i18n: [inlang.vs-code-extension](https://marketplace.visualstudio.com/items?itemName=inlang.vs-code-extension) +- TODO list: [gruntfuggly.todo-tree](https://marketplace.visualstudio.com/items?itemName=gruntfuggly.todo-tree) +- Tailwind IntelliSense: [bradlc.vscode-tailwindcss](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)