https://github.com/nodegui/svelte-nodegui-starter

https://github.com/nodegui/svelte-nodegui-starter

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nodegui/svelte-nodegui-starter
• Owner: nodegui
• Created: 2021-02-27T16:37:26.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-18T22:11:08.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T00:46:41.954Z (3 months ago)
• Language: JavaScript
• Size: 2.27 MB
• Stars: 55
• Watchers: 4
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# svelte-nodegui-starter

**Clone and run for a quick way to see Svelte NodeGui in action.**

![logo](https://github.com/nodegui/svelte-nodegui-starter/raw/master/assets/demo.png)

## To Use

To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer.

Make sure you have met the requirements listed here: https://docs.nodegui.org/#/tutorial/development-environment

From your command line:

```bash

# Copy files from starter repo into a directory called "my-project"

npx degit https://github.com/nodegui/svelte-nodegui-starter my-project

# Go into the repository

cd my-project

# Install dependencies

npm install

# Build the app in development mode (unminified; watch mode on)

npm run dev

# (From another terminal) Run the built app

npm run start

```

## Resources for Learning NodeGui

- [svelte.nodegui.org](https://svelte.nodegui.org) - all of Svelte NodeGui's documentation

## Packaging app as a distributable

In order to distribute your finished app, you can use [@nodegui/packer](https://github.com/nodegui/packer)

### Step 1: (_**Run this command only once**_)

```sh

npx nodegui-packer --init MyAppName

```

This will produce the deploy directory containing the template. You can modify this to suite your needs. Like add icons, change the name, description and add other native features or dependencies. Make sure you commit this directory.

### Step 2: (_**Run this command every time you want to build a new distributable**_)

Next you can run the pack command:

```sh

npm run build

```

This will produce the js bundle along with assets inside the `./dist` directory

```sh

npx nodegui-packer --pack ./dist

```

This will build the distributable using `@nodegui/packer` based on your template. The output of the command is found under the build directory. You should gitignore the build directory.

More details about `@nodegui/packer` can be found here: https://github.com/nodegui/packer

## License

MIT