diff --git a/README.md b/README.md new file mode 100644 index 00000000..92a8bcf9 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# @odit/lfk-frontend + +## ✒️ Overview +This is an API client for [https://git.odit.services/lfk/backend](@lfk/backend) +- WebApp built with [Svelte](https://svelte.dev), [WindiCSS](https://windicss.org/) (to compile [TailwindCSS](https://tailwindcss.com/)) and [Vite](https://vitejs.dev). + +This application is intended for use by admin users/ members only. + +## 🚀 Getting Started +``` +yarn +``` +## Development +``` +yarn dev +/ +yarn dev --open +``` +## Build +``` +yarn build +``` \ No newline at end of file