shadow-hosting/shadow
4
0
Fork 0
Code Issues 8 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Add Package Documentation

shanec 2024-04-21 14:55:59 -04:00
parent de68aa8ffe
commit 7a83d45f71
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
Package-Documentation.md Normal file

@ -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 |