A starter for Svelte using Javascript, Rust and Wasm following the Atomic Design methodology
About - Architecture - Code Style - Format - Unit Testing - Development - Supports
If you like Atomic Design and Component-driven Development but above all Svelte. this starter kit might appeal to you.
I often use this configuration for my creative projects so why not share it with those who are interested. That's what open source is for: sharing.
This starter is not production ready but you can still use it for side projects. for those who want a ts
version, look at the repo rsvelte.
/back
The back
folder is not implemented yet. Feel free to implements your own. For the next step, I will use rust nightly
as a back-end. It will works perfectly with the wasm
folder. For example, if you need to ports some back-end functions to web assembly, it's better to continue using rust
.
/front
The front
folder uses svelte
as a front-end framework and storybook
for the component-driven development. The component approach thus follows the Design Atomic methodology (atoms, molecules, organisms, etc) and the sass
architecture follows the pattern 7-1
of sass-guidelines.
/wasm
The wasm
folder contains all the Web Assembly part using rust nightly
. everything about wasm
should be implemented in this folder.
This starter kit uses estlint
and stylelint
to ensure that your code is clean, readable and follows the best style conventions.
You can format your codebase by running the prettier
command.
see the commands section below.
It supports jest
as a testing framework for javascript
Rust and Cargo must be installed on your machine before.
clone
git clone https://github.com/monsieurbadia/rsvelte-ts.git
install
cd front
yarn install
cmd | desc |
---|---|
build | build the project |
dev | run the dev environment |
fmt | format your entire codebase |
lint:code | check your entire codebase |
lint:style | check your entire style sheets |
start | serve the public environment |
storybook | run the storybook dev environment |
storybook:build | build the storybook project |
test:unit | run the unit tests |
test:clear | clean the jest cache |