From ff741e318faba3df152ba4952f3cb04acb4d8d86 Mon Sep 17 00:00:00 2001 From: Daniel Turcich Date: Mon, 18 Sep 2023 23:06:08 -0400 Subject: [PATCH] updated all packages, fixed configs, updated documentation --- .env.example | 2 +- .gitignore | 2 +- .prettierignore | 8 +- CONTRIBUTING.md | 12 +- FILESTRUCTURE.md | 67 + README.md | 96 +- components.d.ts | 6 +- lib/api/Account.ts | 22 + lib/api/AccountRoute.ts | 22 + lib/api/RunsRoute.ts | 4 +- lib/api/UsersRoute.ts | 2 +- lib/api/data-contracts.ts | 4 +- nuxt.config.ts | 46 +- package.json | 64 +- pnpm-lock.yaml | 4190 ++++++++++++++++++++----------------- vite.config.ts | 45 - vitest.config.ts | 4 +- 17 files changed, 2446 insertions(+), 2150 deletions(-) create mode 100644 FILESTRUCTURE.md delete mode 100644 vite.config.ts diff --git a/.env.example b/.env.example index 14a7e7ce..46d42891 100644 --- a/.env.example +++ b/.env.example @@ -2,4 +2,4 @@ # new variables in here, make sure that they're copied into the # `.env.test`, with a sensible default. -BACKEND_BASE_URL= +BACKEND_BASE_URL=https://lbgg-backend-dev.fly.dev diff --git a/.gitignore b/.gitignore index 2615e00c..b0f99a36 100644 --- a/.gitignore +++ b/.gitignore @@ -95,4 +95,4 @@ sw.* *.swp # For buffet :) -ignore.* \ No newline at end of file +ignore.* diff --git a/.prettierignore b/.prettierignore index ed02dec9..932972fd 100644 --- a/.prettierignore +++ b/.prettierignore @@ -14,13 +14,17 @@ /public /.output +# file types +*.svg +*.md + # files pnpm-lock.yaml .gitkeep -*.svg .gitignore .npmrc .nvmrc .pnpmrc .prettierignore -COPYING \ No newline at end of file +COPYING +components.d.ts \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32a52b1b..0fac3db5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,10 @@ We appreciate your help! +## Discord + +- If you have any questions, comments, concerns that don't fit in GitHub please [direct them here!](https://discord.com/invite/TZvfau25Vb) + ## Before filing an issue If you are unsure whether you have found a bug, please consider asking in [our discord](https://discord.gg/TZvfau25Vb) first. @@ -36,8 +40,10 @@ Filing issues is as simple as going to [the issue tracker](https://github.com/le - Be inclusive, this is a project for everyone. - Be descriptive, it can be hard to understand abbreviations or short-hand. + - prefer `catch(error)` over `catch(e)` - Make sure that your components are _responsive_. - Two major philosphies we adhere to are KISS (keep it super simple) and DRY (don't repeat yourself) + - In general try not to make your code too "clever" if it's possible to do it in a less "clever" way so that it's easily read by other contributors. ### Nuxt/Vue @@ -45,9 +51,11 @@ Filing issues is as simple as going to [the issue tracker](https://github.com/le - Comments above a function should start with the name of the thing being described. - Make sure any data and prop names are as descriptive as possible. - Try to move any repetitive elements into child components to reduce clutter in parent components. -- Use `async await` for any asynchronous functions. +- Prefer usage of `async/await` for asynchronous functions. + - only use Promise syntax for needed more advanced Async programminng that either can't be done or is harder to be done with `async/await` + - Include proper error handling for any `async` functions. -- Make all components compatible with server side rendering when possible. +- Make all components compatible with server side rendering where possible. ### Git diff --git a/FILESTRUCTURE.md b/FILESTRUCTURE.md new file mode 100644 index 00000000..72bb35ec --- /dev/null +++ b/FILESTRUCTURE.md @@ -0,0 +1,67 @@ +# Vue File Structure + +You'll find our Vue files in `components` and `pages`. The files are structured in the order: template, script, and style. One thing to note; we want to keep any and all styling in `