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

add: Missing README.md information.

Browse Source
This commit is contained in:
WildEgo 2025-06-06 00:40:31 +01:00
parent c5cd6a3749
commit 5ffb4d68a8
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -5,6 +5,8 @@
This app is built with the following technologies 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) - Framework: [TanStack Router](https://tanstack.com/router/latest/docs)
- Database: [Drizzle ORM](https://orm.drizzle.team/docs) - Database: [Drizzle ORM](https://orm.drizzle.team/docs)
- Components: [shadcn/ui](https://ui.shadcn.com/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 ## 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. 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. 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. 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)