1 changed files with 39 additions and 5 deletions
@ -1,12 +1,46 @@
@@ -1,12 +1,46 @@
|
||||
# Sveltekit Starter |
||||
# :rocket: Sveltekit Starter |
||||
|
||||
[](https://kit.svelte.dev/) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://tailwindcss.com) [](https://postcss.org) [](https://sass-lang.com/) [](https://storybook.js.org/) [](https://jestjs.io/) [](https://prettier.io/) [](https://eslint.org/) [](https://github.com/navneetsharmaui/sveltekit-starter/blob/main/LICENSE) |
||||
|
||||
 |
||||
|
||||
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…
Reference in new issue