Sveltekit boilerplate
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

51 lines
3.7 KiB

# :rocket: Sveltekit Starter
[![Powered By Sveltekit](https://img.shields.io/badge/powered%20by-svelte-FF3C02.svg?style=flat&logo=svelte)](https://kit.svelte.dev/) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Tailwindcss](https://img.shields.io/badge/Tailwindcss-CSS--Framework-%2338B2AC?logo=tailwindcss)](https://tailwindcss.com) [![Postcss](https://img.shields.io/badge/Postcss-style-%23DD3A0A?style=flat&logo=postcss)](https://postcss.org) [![SCSS](https://img.shields.io/badge/SCSS-Style-%23CC6699?style=flat&logo=sass)](https://sass-lang.com/) [![StorybookJS](https://img.shields.io/badge/Storybook-UI--Webcomponent--tool-%23FF4785?style=flat&logo=storybook)](https://storybook.js.org/) [![Jest](https://img.shields.io/badge/Jest-Unit--Testing--Framework-%23C21325?style=flat&logo=jest)](https://jestjs.io/) [![Prettier](https://img.shields.io/badge/Prettier-code--formatter-%23F7B93E?style=flat&logo=prettier)](https://prettier.io/) [![Eslint](https://img.shields.io/badge/Eslint-linter-%234B32C3?style=flat&logo=eslint)](https://eslint.org/) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/navneetsharmaui/sveltekit-starter/blob/main/LICENSE)
## [Svektekit Blog](https://github.com/navneetsharmaui/sveltekit-blog)
Use the above link if you want to use the sveltekit blog template.
![sveltekit](https://user-images.githubusercontent.com/11630812/114088279-7cd7be80-98d2-11eb-883c-66c3bf48f293.png)
Sveltekit starter project created with Sveltekit, Typescript, Tailwindcss, Postcss, SCSS, Husky, ESLint, Prettier, Storybook, and Jest.
The project has the ***SSR (Server Side Rendering)*** setup. These template is easy to configure and built upon as it has scalable structure.
## :100: :fire: Project LightHouse Report
![sveltekit-starter-lighthouse-report](https://user-images.githubusercontent.com/11630812/115241377-5d485d80-a13e-11eb-8667-611770992c28.png)
## :paperclip: Menu
- :bulb: [Features](#bulb-features)
- :hammer: [Project Setup](#hammer-project-setup)
- :bug: [Known Bugs](https://github.com/navneetsharmaui/sveltekit-starter/issues)
## :bulb: Features
- [:heavy_check_mark:] Server side rendering built with ***SEO*** in mind.
- [:heavy_check_mark:] PWA + Service Worker + Offline.
- [:heavy_check_mark:] Tailwindcss + Postcss + SCSS Syntax Support in Postcss.
- [:heavy_check_mark:] Global Style and Variable preconfigured for Postcss.
- [:heavy_check_mark:] StorybookJS preconfigured (with postcss support).
- [:heavy_check_mark:] Browser sync, auto refresh, auto reload.
- [:heavy_check_mark:] 100% on Google Speedpage and 100% Lighthouse report.
- [:heavy_check_mark:] Friendly and Scalable boilerplate.
- [:heavy_check_mark:] Typescript + TSPaths (absolute for imports in component) preconfigured.
- [:heavy_check_mark:] Prettiers, ESLint, and Husky preconfigured.
- [:heavy_check_mark:] Github and Vscode dotfiles preconfigured.
## :hammer: Project Setup
1. `npx degit navneetsharmaui/sveltekit-starter my-app` or Clone this repository.
2. `npm install` or `yarn install` or `pnpm install`.
3. `npm run dev` or `yarn run dev` or `pnpm run dev`.
4. `npm run build:static:ssr` or `yarn run build:static:ssr` or `pnpm run build:static:ssr`.
5. `npm run preview` or `yarn run preview` or `pnpm run preview`.
## 💫 License
- Code and Contributions have **MIT License**
*Copyright (c) 2021 [Navneet Sharma](http://github.com/navneetsharmaui) ([@asnavneetsharma](https://twitter.com/asnavneetsharma))*