svelte

mirror of https://github.com/sveltejs/svelte.git synced 2024-11-24 16:29:46 +01:00

Cybernetically enhanced web apps https://svelte.dev/

svelte

Go to file

Ben McCann cc1f4bc6ff chore: upgrade eslint config (#8717 )		2023-06-14 19:55:12 +05:45
.changeset	Version Packages (next) (#8709 )	2023-06-08 11:03:52 -04:00
.github	fix: changeset publish script isn't called release anymore (#8711 )	2023-06-08 13:32:15 -07:00
.vscode	chore: playground (#8648 )	2023-06-07 19:22:45 -04:00
packages	chore: upgrade eslint config (#8717 )	2023-06-14 19:55:12 +05:45
site/content	feat: allow #each to iterate over iterables (#8626 )	2023-05-26 13:29:43 +02:00
.editorconfig	chore: remove unnecessary indent_size from editorconfig (#5992 )	2021-02-17 15:57:35 -05:00
.gitattributes	Add a linguist configuration (#5878 )	2021-01-18 11:46:51 -08:00
.gitignore	chore: playground (#8648 )	2023-06-07 19:22:45 -04:00
.prettierrc	chore: add prettier (#8543 )	2023-05-08 23:32:52 +02:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md (#7183 )	2022-01-25 08:48:47 +00:00
CONTRIBUTING.md	chore: convert to monorepo (#8644 )	2023-05-26 16:17:13 -07:00
LICENSE.md	Update license year (#8227 )	2023-01-27 11:22:52 -05:00
package.json	chore: upgrade eslint config (#8717 )	2023-06-14 19:55:12 +05:45
pnpm-lock.yaml	chore: upgrade eslint config (#8717 )	2023-06-14 19:55:12 +05:45
pnpm-workspace.yaml	chore: convert to monorepo (#8644 )	2023-05-26 16:17:13 -07:00
README.md	chore: convert to monorepo (#8644 )	2023-05-26 16:17:13 -07:00

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:

Becoming a backer on Open Collective.

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.

Roadmap

You may view our roadmap if you'd like to see what we're currently working on.

Contributing

Please see the Contributing Guide and svelte package for contributing to Svelte.

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
pnpm install

Do not use Yarn to install the dependencies, as the specific package versions in pnpm-lock.json are used to build and test Svelte.

To build the compiler and all the other modules included in the package:

pnpm build

To watch for changes and continually rebuild the package (this is useful if you're using pnpm link to test out changes in a project locally):

pnpm 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

pnpm test

To filter tests, use -g (aka --grep). For example, to only run tests involving transitions:

pnpm test -- -g transition

svelte.dev

The source code for https://svelte.dev lives in the sites repository, with all the documentation in the site/content directory. The site is built with SvelteKit.

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.

License

MIT