README.md

plant-journal 🪴

This template should help get you started developing with Vue 3 in Vite.

Features

Features - to be implemented

• 🏗 Advice on how to treat certain plants 🌷

• 🏗 Import information for different plants 🌻

• 🏗 Create, edit and delete plant entries 🍃

• 🏗 Overview of your plants 😲

• 🏗 Reminders when you should look after your plant next based on entered parameters 🌵

• 🏗 Dark Mode 🚀

• 🏗 and more to come...

🦾 Stay on top of the plant game and lean back since the app reminds you when it's time to pour them again 💧🚰

Tech Stack (WIP) 🏡

• ⚡️ Vue 3, Vite, pnpm, esbuild - born with fastness

• 🍍 State Management via Pinia

• 🔥 Use the new <script setup> syntax

• 🤙🏻 Reactivity Transform enabled

• 📥 APIs auto importing - use Composition API and others directly

• ⚙️ Unit Testing with Vitest, E2E Testing with Cypress on GitHub Actions

• 🦾 TypeScript, of course

• ☁️ Deploy on xxx, zero-config

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

pnpm i

Compile and Hot-Reload for Development

pnpm run dev

Type-Check, Compile and Minify for Production

pnpm run build

Run Unit Tests with Vitest

pnpm run test:unit

Run End-to-End Tests with Cypress

ppnpm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing

Lint with ESLint

pnpm run lint