| 1 | <p>
|
| 2 | <a href="https://svelte.dev">
|
| 3 | <img alt="Cybernetically enhanced web apps: Svelte" src="https://sveltejs.github.io/assets/banner.png">
|
| 4 | </a>
|
| 5 |
|
| 6 | <a href="https://www.npmjs.com/package/svelte">
|
| 7 | <img src="https://img.shields.io/npm/v/svelte.svg" alt="npm version">
|
| 8 | </a>
|
| 9 |
|
| 10 | <a href="https://github.com/sveltejs/svelte/blob/master/LICENSE">
|
| 11 | <img src="https://img.shields.io/npm/l/svelte.svg" alt="license">
|
| 12 | </a>
|
| 13 | </p>
|
| 14 |
|
| 15 |
|
| 16 | ## What is Svelte?
|
| 17 |
|
| 18 | 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.
|
| 19 |
|
| 20 | Learn more at the [Svelte website](https://svelte.dev), or stop by the [Discord chatroom](https://svelte.dev/chat).
|
| 21 |
|
| 22 |
|
| 23 | ## Development
|
| 24 |
|
| 25 | Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and help us out!
|
| 26 |
|
| 27 | To install and work on Svelte locally:
|
| 28 |
|
| 29 | ```bash
|
| 30 | git clone https://github.com/sveltejs/svelte.git
|
| 31 | cd svelte
|
| 32 | npm install
|
| 33 | ```
|
| 34 |
|
| 35 | > Do not use Yarn to install the dependencies, as the specific package versions in `package-lock.json` are used to build and test Svelte.
|
| 36 |
|
| 37 | To build the compiler, and all the other modules included in the package:
|
| 38 |
|
| 39 | ```bash
|
| 40 | npm run build
|
| 41 | ```
|
| 42 |
|
| 43 | To watch for changes and continually rebuild the package (this is useful if you're using [npm link](https://docs.npmjs.com/cli/link.html) to test out changes in a project locally):
|
| 44 |
|
| 45 | ```bash
|
| 46 | npm run dev
|
| 47 | ```
|
| 48 |
|
| 49 | The compiler is written in [TypeScript](https://www.typescriptlang.org/), 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](https://code.visualstudio.com/) you may need to install a plugin in order to get syntax highlighting and code hints etc.
|
| 50 |
|
| 51 |
|
| 52 | ### Running Tests
|
| 53 |
|
| 54 | ```bash
|
| 55 | npm run test
|
| 56 | ```
|
| 57 |
|
| 58 | To filter tests, use `-g` (aka `--grep`). For example, to only run tests involving transitions:
|
| 59 |
|
| 60 | ```bash
|
| 61 | npm run test -- -g transition
|
| 62 | ```
|
| 63 |
|
| 64 |
|
| 65 | ## svelte.dev
|
| 66 |
|
| 67 | The source code for https://svelte.dev, including all the documentation, lives in the [site](site) directory. The site is built with [Sapper](https://sapper.svelte.dev).
|
| 68 |
|
| 69 | ### Is svelte.dev down?
|
| 70 |
|
| 71 | Probably not, but it's possible. If you can't seem to access any `.dev` sites, check out [this SuperUser question and answer](https://superuser.com/q/1413402).
|
| 72 |
|
| 73 | ## License
|
| 74 |
|
| 75 | [MIT](LICENSE)
|