README.md

Frontend - Your modern carsharing solution

also see Voycar Backend!

Technology Overview

• JavaScript (using Node.js)
• Skeleton, including...
  • Tailwind CSS
  • SvelteKit, including...
    • Svelte
    • Vite
• Code style and debugging
  • ESLint
  • Prettier
  • Svelte Inspector

Installation and Usage

• Have Docker set up
• Get the source code, e.g. with...

git clone https://github.com/solid-stack-solutions/voycar-frontend
cd voycar-frontend

• Run docker compose up

Development

Requires node / npm

# run app locally
npm run dev
# reload by typing "r" and enter in the terminal
# inspect svelte components with ctrl+alt+i in webapp

# check formatting / code style
npm run check-format
# apply configured formatting rules
npm run format

Conventions

• Run npm run format before creating a PR
• Comments start with a space and a capital letter, e.g. // This is a comment