diff --git a/Package-Documentation.md b/Package-Documentation.md new file mode 100644 index 0000000..1ed75f3 --- /dev/null +++ b/Package-Documentation.md @@ -0,0 +1,21 @@ +This is a list containing links to documentation to packages that are being used within the project. They are split between the frontend and backend. + +## Backend +> Backend is made with Golang, using Cobra as the cli manager for it. + +| Package Name | Purpose | Docs Link | +|--------------|------------------------|---------------------------------------------------------------------| +| Fiber (v2) | Webserver | https://docs.gofiber.io | +| Cobra | CLI Manager | https://github.com/spf13/cobra/blob/main/site/content/user_guide.md | +| Zap | Logger | https://pkg.go.dev/go.uber.org/zap | +| go-json | JSON Encoding/Decoding | https://github.com/goccy/go-json | + +## Frontend +> Frontend is made with SvelteKit and Vite, using TailwindCSS with DaisyUI for the UI + +| Package Name | Docs Link | +| ------------ |------------------------------| +| SvelteKit | https://kit.svelte.dev/docs | +| Vite | https://vitejs.dev | +| TailwindCSS | https://tailwindcss.com/docs | +| DaisyUI | https://daisyui.com/docs | \ No newline at end of file