search

woltsu / tsynamo

Type-friendly TypeScript DynamoDB query builder!
MIT License
31 stars 6 forks source link

Add project website + docs (Docusaurus) #23

Closed robinellgren closed 5 months ago

robinellgren commented 5 months ago

👋 Thanks for a great project! It's going to be awesome to transform all my Dynamo queries into something readable using this lib.

Many other projects in this space use Docusaurus as their website to get an easy website to setup + nice looking docs. Thought it might be a good idea also for this project to really showcase all it's glory 👏

This PR adds a new folder www with a complete website and all Docs of the current implemented Dynamo functions.

A lot of this PR is mostly a combination of Hasura, tRPC and Kysely which all use Docusaurus 🐲

Run instructions:

cd www
pnpm install
pnpm start

Here is some screenshots how it looks:

image image

This is just compiled into JS + CSS + HTML so it can easily be hosted anywhere! Most projects I see tend to use Vercel (which has a free hobby plan that should suffice?) for this but it can be hosted anywhere. Don't know where tsynamo.dev currently is but it should be a breeze to deploy!

Let me know what you think 🎉

woltsu commented 5 months ago

Thank you for creating this PR! ⭐ I will definitely spend some time to set it up and run it on my home server! 🚀