Boilerplate Complete and updated with Sveltekit, Typescript, CSS Modules, Tests and more

:memo: About the Project

This application is a boilerplate for complex and large systems, especially those that need to scale with security and code quality.

We sought to achieve 3 pillars: readability, reusability, and refactorability.

In the construction of the UI, the Atomic Design structure was chosen, organizing the global components into atoms, molecules, organisms and templates.

In addition to being constantly updated, this project was configured in the smallest details to serve as a basis for professional projects that require standardized and easy-to-maintain code architecture and design.

:pushpin: Contents

• Technologies
• Features
• Prerequisites
• How to install and run the project
  • Clone Repository
  • Install Dependencies
  • Start Development Environment
  • Generate Production Build
  • Start Production Environment
  • Run Tests
  • Run Tests in Watch Mode
  • Run Lints
  • Format code with prettier
  • Check for Available Updates for Dependencies
• Important Considerations
• Author

:globe_with_meridians: Technologies

🚀 Sveltekit

🔥 TypeScript

💅 CSS Module

🚩 Lints: Lefthook, ESlint, Prettier and Commitlint

✅ Tests: Vitest and Playwright

:triangular_flag_on_post: Features

• Responsive design;

• Atomic Design;

• 100% coverage;

• Detection prefers-reduced-motion;

:white_check_mark: Prerequisites

• node (latest version lts).

• pnpm (latest version lts).

:question: How to install and run the project

Clone Repository

git clone https://github.com/everton-dgn/boilerplate_sveltekit.git

Install Dependencies

pnpm i

Start Development Environment

pnpm dev

Available in http://localhost:3000

Generate Production Build

pnpm build

Start Production Environment

pnpm preview

Available in http://localhost:3000

Run Tests

pnpm test

Run Tests in Watch Mode

pnpm test:w

Available in http://localhost:6006

Run Lints

pnpm lint

pnpm typecheck

pnpm check:format

Format code with prettier

pnpm format

Check for Available Updates for Dependencies

pnpm check:update

:rotating_light: Important Considerations

• The husky is configured to not allow commit if there are any lint and typescript errors. The push can only be done if all tests and builds pass.

• Due to husky's build check settings, to push with git, the development server must be stopped first or an error will occur in the git push command.

:technologist: Author

By Éverton Toffanetto.

:link: LinkedIn: https://www.linkedin.com/in/everton-toffanetto

:link: YouTube: https://youtube.com/@toffanettodev