Samuel Plumppu
172f294cb6
|
3 years ago | |
|---|---|---|
| .github | 4 years ago | |
| site | 3 years ago | |
| src | 3 years ago | |
| test | 3 years ago | |
| .editorconfig | 4 years ago | |
| .eslintignore | 5 years ago | |
| .eslintrc.js | 5 years ago | |
| .gitattributes | 4 years ago | |
| .gitignore | 4 years ago | |
| .mocharc.js | 4 years ago | |
| CHANGELOG.md | 3 years ago | |
| CONTRIBUTING.md | 4 years ago | |
| LICENSE.md | 4 years ago | |
| README.md | 4 years ago | |
| check_publish_env.js | 4 years ago | |
| package-lock.json | 3 years ago | |
| package.json | 3 years ago | |
| register.js | 5 years ago | |
| rollup.config.js | 4 years ago | |
| tsconfig.json | 4 years ago | |
README.md
What is Svelte?
Svelte is a new way to build web applications. It's a compiler that takes your declarative components and converts them into efficient JavaScript that surgically updates the DOM.
Learn more at the Svelte website, or stop by the Discord chatroom.
Supporting Svelte
Svelte is an MIT-licensed open source project with its ongoing development made possible entirely by fantastic volunteers. If you'd like to support their efforts, please consider:
Funds donated via Open Collective will be used for compensating expenses related to Svelte's development such as hosting costs. If sufficient donations are received, funds may also be used to support Svelte's development more directly.
Development
Pull requests are encouraged and always welcome. Pick an issue and help us out!
To install and work on Svelte locally:
git clone https://github.com/sveltejs/svelte.git
cd svelte
npm install
Do not use Yarn to install the dependencies, as the specific package versions in
package-lock.jsonare used to build and test Svelte.
To build the compiler and all the other modules included in the package:
npm run build
To watch for changes and continually rebuild the package (this is useful if you're using npm link to test out changes in a project locally):
npm run dev
The compiler is written in TypeScript, but don't let that put you off — it's basically just JavaScript with type annotations. You'll pick it up in no time. If you're using an editor other than Visual Studio Code, you may need to install a plugin in order to get syntax highlighting and code hints, etc.
Running Tests
npm run test
To filter tests, use -g (aka --grep). For example, to only run tests involving transitions:
npm run test -- -g transition
svelte.dev
The source code for https://svelte.dev, including all the documentation, lives in the site directory. The site is built with Sapper.
Is svelte.dev down?
Probably not, but it's possible. If you can't seem to access any .dev sites, check out this SuperUser question and answer.