NENCE Template

Template for standalone desktop apps using a tech stack containing NodeJS, ExpressJS, NeDB, Camo, and ElectronJS.

Usage

Basic Usage

Assuming that you have a version of NodeJS installed that contains NPM, simply run the following command from your desired working directory and follow its prompts:

npx @bigfootds/nence-template --name your-cool-app-name

This command follows the syntax of "npx nence-template {project name}", and you can see in the above example that the project name would be your-cool-app-name. The default project name is myapp, so if you run the npx command without providing a name, you will have that directory created within your working directory.

To create a project in the current working directory, run the command but use a period as the project name, like so:

npx @bigfootds/nence-template --name .

Including A Front-End

The NENCE stack is typically to make an API run as a standalone application. If you also want a web interface for this API to be bundled as part of that API (as a monolithic full-stack application), you can specify a template that includes a front-end - such as NENCER. Your command should look like the following, specifying a template:

npx @bigfootds/nence-template --name . --stack nencer

Of course, if you want to keep your user interface separate from the UI (eg. if you want to keep your front-end as a separate repository or separate microservice, away from this back-end/standalone system), simply don't specify a stack. The API will be accessible to whatever front-end makes web requests to it, such as websites or videogame clients, even if you don't use a NENCER stack.

Commands & Arguments

--name, -n

Default value: myapp

This is the name of the directory that will be created, and where the project using the NENCE app will be located.

There is one exception to this: .

If a . is provided as the value for this argument, then no directory will be created - and the NENCE app will be located in the current working directory.

--stack, -s

Default value: nence

This specifies which template to use. Accepted values are:

• nence - The typical NENCE stack outlined earlier in this document.
• nencer - The same as above, plus an embedded front-end client made with ReactJS.

Compliance & Dependencies

This installer wizard uses these dependencies:

The NENCE app stack uses these dependencies:

| Package | License | Source Repository | Dependency Type | |------------|---------|-------------------| --------------- | | NodeJS | | | Production | | ExpressJS | | | Production | | NeDB | | | Production | | Camo | | | Production | | ElectronJS | | | Development | | detect-port | | | Production | | bcryptjs | | | Production | | cors | | | Production | | dotenv | | | Production | | helmet | | | Production | | ip | | | Production | | nodemon | | | Development |

The NENCER app stack uses the same dependencies as NENCE, plus the following:

| Package | License | Source Repository | Dependency Type | |------------|---------|-------------------| --------------- | | ReactJS | | | Production |