Everything you need to build a Svelte project, powered by create-svelte
;
If you're seeing this, you've probably already done this step. Congrats!
# create a new project in the current directory
npm init svelte@next
# create a new project in my-app
npm init svelte@next my-app
Note: the
@next
is temporary
Once you've created a project and installed dependencies with npm install
(or pnpm install
or yarn
), start a development server:
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
Svelte apps are built with adapters, which optimise your project for deployment to different environments.
By default, npm run build
will generate a Node app that you can run with node build
. To use a different adapter, add it to the devDependencies
in package.json
making sure to specify the version as next
and update your svelte.config.cjs
to specify your chosen adapter. The following official adapters are available:
- @sveltejs/adapter-node
- @sveltejs/adapter-static
- @sveltejs/adapter-netlify
- @sveltejs/adapter-vercel
- ...more soon
See the adapter documentation for more detail
This repository uses battlecry
to generate components. To use it type npx battlecry g component YourComponentName
or npm run cry g component YourComponentName
to generate component with directory of src/lib/components/YourComponentName
and all necessary files:
YourComponentName.svelte
YourComponentName.test.ts
YourComponentName.stories.js
If you want to pass additional path, for instances primitives
, to have your component generated at src/lib/components/primitives/YourComponentName
instead, just pass -p pathname
to the generator like so: npx battlecry g component -p primitives YourComponentName
The directories will be automatically generated along with all files.