Browse Source

Updated the readme

pull/5/head
Navneet Sharma 1 year ago
parent
commit
18b2d49820
  1. 44
      README.md

44
README.md

@ -1,12 +1,46 @@ @@ -1,12 +1,46 @@
# Sveltekit Starter
# :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)
![sveltekit](https://user-images.githubusercontent.com/11630812/114088279-7cd7be80-98d2-11eb-883c-66c3bf48f293.png)
Sveltekit starter project created with sveltekit, typescript, tailwindcss, postcss, husky, and storybook.
The project has the structure setup for the scaleable project.
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.
**Project LightHouse Report :100: :fire:**
## :paperclip: Menu
- :bulb: [Features](#-features)
- :hammer: [Project Setup](#-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:] 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
## Project Setup
### :pushpin: TODO
1. `npx degit navneetsharmaui/sveltekit-starter my-app`.
- [:heavy_multiplication_x:] Images LazyLoad
- [:heavy_multiplication_x:] Route Transition animation
- [:heavy_multiplication_x:] E2E Test configuration using Cypress
- [:heavy_multiplication_x:] JEST Test configuration
- [:heavy_multiplication_x:] Internationalization (i18n)
## :hammer: Project Setup
1. `npx degit navneetsharmaui/sveltekit-starter my-app` or Clone this repository.
2. `yarn install`.
3. `yarn dev`.
## 💫 License
- Code and Contributions have **MIT License**
*Copyleft (c) 2021 [Navneet Sharma](https://navnetsharma.tech) ([@asnavneetsharma](https://twitter.com/asnavneetsharma))*

Loading…
Cancel
Save