finn-e / kgsweb

The website of the Kentucky Geological Survey

@kygeosurvey/kgsweb-app

This is a sidebase cheviot app created by running npm create sidebase@latest. This project uses the following technologies for a great developer- and user-experience:

• TypeScript
• Nuxt 3
• Database models, migrations, queries and easy DB-switching via Prisma
• Deep Prisma integration: Use the client in your endpoints via nuxt-prisma, Prisma client is auto-generated for npm run dev and other commands and more
• Frontend- and Backend data-transformation via nuxt-parse and zod
• In-memory development SQL-database via sqlite3
• Linting via eslint
• Test management, Test UI, component snapshotting via vitest
• Component tests via test-library/vue
• Nuxt 3 native API testing via @nuxt/test-utils
• Code coverage via c8
• CSS utilities via TailwindCSS
• CSS components via Naive UI
• Type checking in script and template via Volar / vue-tsc
• Code editor configuration via .editorconfig files and a portable .settings/ folder whith best-practice VS Code settings and extensions for Vue 3 / Nuxt 3 development

How to get going?

This is a straight-forward setup with minimal templating and scaffolding. The options you selected during the sidebase CLI setup are all here though. Good places to continue reading are:

• the First Steps documentation
• our discord

Some tasks you should probably do in the beginning are:

• replace this generic README with a more specific one
• install the Vue Volar extension
• enable Volar takeover mode to ensure a smooth editor setup
• install Nuxt 3 devtools if you want to use them

Setup

Make sure to install the dependencies:

npm install

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview