Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pegvin/Create-Neutralino-App
Set up a NeutralinoJS App by running one command.
https://github.com/pegvin/Create-Neutralino-App
create-neutralino-app neutralinojs
Last synced: 3 months ago
JSON representation
Set up a NeutralinoJS App by running one command.
- Host: GitHub
- URL: https://github.com/pegvin/Create-Neutralino-App
- Owner: pegvin
- License: mit
- Created: 2022-02-05T03:12:11.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-12T13:22:56.000Z (over 2 years ago)
- Last Synced: 2024-11-07T09:47:37.639Z (3 months ago)
- Topics: create-neutralino-app, neutralinojs
- Language: JavaScript
- Homepage: https://npmjs.com/create-neutralino-app
- Size: 225 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neutralino - Create Neutralino App - Set up a NeutralinoJS App by running one command (Tools / For Neutralino)
README
# Create Neutralino App
Set up a NeutralinoJS App by running one command.
```bash
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
```bash
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](https://nodejs.org/download/release/v12.20.0/) 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:
```bash
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](https://github.com/DEVLOPRR/svelte-neutralino))
2. Make A Pull Request Adding Properties For Your Template in [`template-urls.js`](https://github.com/DEVLOPRR/Create-Neutralino-App/blob/main/src/template-urls.js)
3. Wait For your Request To Be Pulled.
### Properties For Template:
Your Properties Should Look Like This
```javascript
"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