create-svelte

Everything you need to build a Svelte project, powered by create-svelte.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

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

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Deploy to GitHub Pages

To deploy to GitHub pages

1. Create a repository on GitHub pages
2. Link this local repository to the one created.
3. Update the URL in svelteconfig.js with the name of your GitHub repository
4. Run the deploy script from packages.json

   npm run deploy
   

   or

   yarn deploy
   

5. Go to the repository page and check that the GitHub actions completes