/gather-your-party-with-svelte

Workshop to learn Svelte by creating your own character creator!

Primary LanguageSvelteGNU General Public License v3.0GPL-3.0

Gather your Party with Svelte

Getting started

  1. Make sure you have Node v16.14+ installed with node --version.
  2. Clone the repository to your work environment: git clone git@github.com:miles-no/gather-your-party-with-svelte.git or git clone https://github.com/miles-no/gather-your-party-with-svelte.git.
  3. Install dependencies with npm install.
  4. To start the development server and open the application: npm run dev -- --open (or npm run dev to run without opening a new window).

Workshop

All tasks are listed in the file workshop-tasks.md located at the root of the project.

Both this readme file and the workshop-tasks (as Quests) file can be viewed in the local app.

Solutions

When working with quests there will always be an accompanying solutions file.

If the task is located in my-quest.svelte the solution file will be called my-quest.SOLUTION.svelte (or SOLUTION.+page.svelte for a route, and my-quest.SOLUTION for a route folder).

Use this knowledge at your own discretion, but we recommend not looking at these unless you are out of other options.

Tips

  • To clear local data (characters that have been saved), run npm run clear-data.
  • If you're unfamiliar with TypeScript and do not wish to use it in your Svelte component files, you can remove the lang="ts" attribute at the top of the <script> tag in components, and strip out any TypeScript types in the file.
  • While it's not necessary, if you like using a code style formatter, prettier is set up in this project. You can run it in two different ways:
    • If you have it set up in your Editor you can run it via the editor on the file you're working on.
    • Run npm run format in the terminal to format all your sourcefiles.

Building

To build the application run: npm run build.

Alternative: Workshop using Codesandbox as IDE

Create new template

  1. Go to https://codesandbox.io.
  2. Login with your user.
  3. Click Create.
  4. Select Import from GitHub.
  5. Paste in https://github.com/miles-no/gather-your-party-with-svelte.git.
  6. Click Import and Fork.

Links