feat: Migrate ESLint to flat config and resolve initial linting errors
Migrated the ESLint configuration to the new flat config format () and addressed several initial linting errors. Key changes include: - Updated ESLint configuration to treat as warnings instead of errors. - Fixed errors in by declaring and . - Corrected error in by using instead of an out-of-scope . - Resolved error in by replacing the undefined directive with the component. - Addressed errors in by replacing with and with . - Fixed errors in by importing necessary modules (, , ) and adding missing props (, , , , ).
This commit is contained in:
Scott Idem
68
README.md
68
README.md
@@ -2,38 +2,46 @@
|
||||
|
||||
This uses SvelteKit version 2.x with Svelte version 5.x, TailwindCSS 4.1, and Skelton.
|
||||
|
||||
|
||||
# Current Modules
|
||||
|
||||
## AE Events - Speakers (/events_speakers)
|
||||
|
||||
### Components
|
||||
* +page.svelte - The main page for the Events - Speakers module
|
||||
* 10_edit_modal__event_presenter_obj.svelte - The modal for editing a presenter
|
||||
* 10_list__event_presenter_obj.svelte - The list of presenters/speakers
|
||||
* 10_view_modal__event_presenter_obj.svelte - The modal for viewing a presenter
|
||||
|
||||
- +page.svelte - The main page for the Events - Speakers module
|
||||
- 10_edit_modal\_\_event_presenter_obj.svelte - The modal for editing a presenter
|
||||
- 10_list\_\_event_presenter_obj.svelte - The list of presenters/speakers
|
||||
- 10_view_modal\_\_event_presenter_obj.svelte - The modal for viewing a presenter
|
||||
|
||||
### Path [slug]
|
||||
* +page.svelte - The main page for the presenter ID [slug]
|
||||
|
||||
- +page.svelte - The main page for the presenter ID [slug]
|
||||
|
||||
## AE Sponsorships (/sponsorships)
|
||||
* +page.svelte - The main page for the Sponsorships module
|
||||
* 10_edit_modal__sponsorship_obj.svelte - The modal for editing a sponsorship
|
||||
* 10_list__sponsorship_obj.svelte - The list of sponsorships
|
||||
* 10_view_modal__sponsorship_obj.svelte - The modal for viewing a sponsorship
|
||||
### Path [slug]
|
||||
* +page.svelte - The main page for the sponsorship ID [slug]
|
||||
|
||||
- +page.svelte - The main page for the Sponsorships module
|
||||
- 10_edit_modal\_\_sponsorship_obj.svelte - The modal for editing a sponsorship
|
||||
- 10_list\_\_sponsorship_obj.svelte - The list of sponsorships
|
||||
- 10_view_modal\_\_sponsorship_obj.svelte - The modal for viewing a sponsorship
|
||||
|
||||
### Path [slug]
|
||||
|
||||
- +page.svelte - The main page for the sponsorship ID [slug]
|
||||
|
||||
# Future Modules
|
||||
|
||||
## AE Events - Badges (/events_badges)
|
||||
* +page.svelte - The main page for the Events - Badges module
|
||||
* 10_list__event_badge_obj.svelte - The list of badges
|
||||
* 10_view_modal__event_badge_obj.svelte - The modal for viewing a badge
|
||||
|
||||
- +page.svelte - The main page for the Events - Badges module
|
||||
- 10_list\_\_event_badge_obj.svelte - The list of badges
|
||||
- 10_view_modal\_\_event_badge_obj.svelte - The modal for viewing a badge
|
||||
|
||||
## AE Events - Exhibit Leads (/events_exhibit_leads)
|
||||
|
||||
## AE Events - Presentation Management (/events_pres_mgmt)
|
||||
|
||||
|
||||
# How to build and deploy SvelteKit:
|
||||
|
||||
Copy the contents of the "build" directory to ./npm_deploy/build/
|
||||
|
||||
```bash
|
||||
@@ -41,6 +49,7 @@ npm run build
|
||||
```
|
||||
|
||||
If this is just a quick build update then only the build directory needs to be copied (rsync).
|
||||
|
||||
```bash
|
||||
rsync -vhrz --exclude 'node_modules' ~/OSIT_dev/ae_app_svelte_tailwind_skeleton/build/ ~/OSIT_dev/ae_env_node_app/npm_deploy/build/ --delete
|
||||
|
||||
@@ -50,6 +59,7 @@ rsync -vhrz ~/OSIT_dev/ae_env_node_app/npm_deploy/build/ scott@linode.oneskyit.c
|
||||
If this includes package updates (not development) we need to copy the new package.json. Manually copy the new package.json file to ./npm_deploy/. This also needs to be copied to the server. Copy the package.json even though not really used.
|
||||
|
||||
Run the --omit dev to clear out the node_modules directory. Copy the root node_modules directory to ./npm_deploy/build/node_modules/ after running te omit dev command.
|
||||
|
||||
```bash
|
||||
npm ci --omit dev
|
||||
|
||||
@@ -63,10 +73,10 @@ npm install
|
||||
|
||||
Everything should be ready to run on the development server and production server.
|
||||
|
||||
|
||||
# Rebuild the node_modules directory and manually install extra Svelte packages
|
||||
|
||||
Run the npm update to fix the node_modules directory and package.json
|
||||
|
||||
```bash
|
||||
npm list
|
||||
npm outdated
|
||||
@@ -77,6 +87,7 @@ npm list
|
||||
|
||||
Other installs?:
|
||||
Are both still needed? I know at least one of these is. 2024-07-23
|
||||
|
||||
```bash
|
||||
npm install --save-dev svelte-highlight
|
||||
npm install --save-dev typescript-svelte-plugin
|
||||
@@ -96,13 +107,15 @@ npm install flowbite flowbite-svelte tailwind-merge @popperjs/core
|
||||
I am slowly switching from Font-Awesome to Lucide
|
||||
|
||||
## Tiptap Editor
|
||||
* Eventually use Edra? https://edra.tsuzat.com/
|
||||
* Best Rich Text Editor, made for Svelte Developers with Tiptap
|
||||
* ShadEditor is "evolving" to be Edra.
|
||||
* ShadCN is still stuck on Tailwind 3. Waiting to upgrade to Tailwind 4.x. Tailwind 4.x was released in late January 2025. ShadCN is still being worked on as of late March 2025.
|
||||
* [https://github.com/huntabyte/shadcn-svelte/issues/1643](https://github.com/huntabyte/shadcn-svelte/issues/1643)
|
||||
|
||||
- Eventually use Edra? https://edra.tsuzat.com/
|
||||
- Best Rich Text Editor, made for Svelte Developers with Tiptap
|
||||
- ShadEditor is "evolving" to be Edra.
|
||||
- ShadCN is still stuck on Tailwind 3. Waiting to upgrade to Tailwind 4.x. Tailwind 4.x was released in late January 2025. ShadCN is still being worked on as of late March 2025.
|
||||
- [https://github.com/huntabyte/shadcn-svelte/issues/1643](https://github.com/huntabyte/shadcn-svelte/issues/1643)
|
||||
|
||||
Need to install ShadCN and Lucide for the Tiptap editor.
|
||||
|
||||
```bash
|
||||
npm install shadcn-svelte
|
||||
npm install lucide-svelte
|
||||
@@ -110,6 +123,7 @@ npm install mode-watcher
|
||||
```
|
||||
|
||||
Now we initialize the ShadCN and ShadEditor packages. Follow the command line instructions.
|
||||
|
||||
```bash
|
||||
npx shadcn-svelte@next init
|
||||
npx shadcn-svelte@next add dropdown-menu button tooltip input popover separator
|
||||
@@ -117,6 +131,7 @@ npx shadeditor init
|
||||
```
|
||||
|
||||
More packages related to the Tiptap editor???
|
||||
|
||||
```bash
|
||||
npm install @tiptap/extension-link @tiptap/extension-bullet-list @tiptap/extension-history @tiptap/extension-typography @tiptap/extension-underline
|
||||
```
|
||||
@@ -124,23 +139,31 @@ npm install @tiptap/extension-link @tiptap/extension-bullet-list @tiptap/extensi
|
||||
## Build
|
||||
|
||||
## Environment file
|
||||
|
||||
### ".env"
|
||||
|
||||
This is the default used if others are not found when when "npm run dev" or "npm run build" is run.
|
||||
|
||||
### ".env.local"
|
||||
|
||||
This is used when "npm run dev" is run. This is not used in the production build.
|
||||
|
||||
### ".env.production"
|
||||
|
||||
This is used when "npm run build" is run. This is not used in the development build.
|
||||
|
||||
### ".env:prod"
|
||||
|
||||
This is modified to allow for a staging environment and production environment built.
|
||||
|
||||
### ".env:staging"
|
||||
|
||||
This is modified to allow for a staging environment and production environment built.
|
||||
|
||||
### Example Important Values when running in dev:
|
||||
|
||||
Note: Environment values need to be updated when our home IP address changes. Be sure to check the Aether Container Environment and Aether Node App (SvelteKit) Environment files for the correct IP address. The Node Docker environment needs to be updated here and in the .env file that Docker will read. This needs to be improved later...
|
||||
|
||||
```bash
|
||||
DOCKER_AE_API_DEV_SERVER_EXTRA_HOST=dev-api.oneskyit.com:108.48.200.147
|
||||
|
||||
@@ -150,7 +173,6 @@ PUBLIC_AE_API_SERVER=api.oneskyit.com
|
||||
PUBLIC_AE_API_BAK_SERVER=bak-api.oneskyit.com
|
||||
```
|
||||
|
||||
|
||||
# create-svelte
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
|
||||
|
||||
Reference in New Issue
Block a user