Create Neutralino App

Set up a NeutralinoJS App by running one command.

npx create-neutralino-app

Want to setup a custom template from GitHub?

if you want to get a custom template from github then you can run this command

npx create-neutralino-app USERNAME/REPOSITORY

here USERNAME is the GitHub Username where the REPOSITORY is located, and REPOSITORY is name of repository which has the template.

Requirement

• Node v12.20 or Greater
• NPM Or Yarn
• NPX

Want To Add A Template?

There are 2 ways to add your template you can either specify the template in the command:

npx create-neutralino-app USERNAME/REPOSITORY

here USERNAME is the GitHub Username where the REPOSITORY is located, and REPOSITORY is name of repository which has the template.

Or If want your template to be a listed as an option in create-neutralino-app,

1. Put your template onto a GitHub Repository (Example - Neutralino Svelte Template)
2. Make A Pull Request Adding Properties For Your Template in template-urls.js
3. Wait For your Request To Be Pulled.

Properties For Template:

Your Properties Should Look Like This

"mytemplate": {
  src: "USERNAME/REPO-NAME",
  commands: [
    {
      command: "Your Command",
      description: "Your Command Description"
    }
  ],
  recomendedCommands: [
    "my command 1",
    "my command 2",
  ]
}

• "mytemplate" is the Name of your template which will show in CLI Menu

• src is template github URL

  • Here your USERNAME is the your github username in which the template repository is in.
  • Here your REPO-NAME is the repository which contains the template.

• commands is list of Commands in your template

  • every command here is a object containing 2 properties:
    • command name of the command.
    • description a little information about that command.

• recomendedCommands is list of Commands which will be recommended to run before doing anything.

  • every command here is a string.

THANKS