Skeleton module for NodeJS

This repository contains the base for a new node module. The following components have been preconfigured

• File structure
• TypeScript (with auto-generated declaration file)
• Unit Tests with Mocha
• Gitlab CI (style, build, test)
• Editor config (Download EditorConfig for Visual Studio Code)
• Git ignore
• Debug profile for Unit Tests (Visual Studio Code only)

Dependencies

Make sure you have the following things in your path:

• NodeJS (v6.9.4+)
• NPM (v3.10.10+)
• tsc (npm install -g tsc)
• jq (https://stedolan.github.io/jq/download/)
• sed (any recent version)

Frameworks

This skeleton was built using:

• NodeJS v6.9.4
• NPM v3.10.10

Setup

1. Install the required frameworks and dependencies

• NodeJS and NPM

2. Open a new Terminal window and navigate to the root folder of this project.
3. Execute npm install to install all the dependencies.
4. ???
5. PROFIT

Creating a new module

It's very easy to copy this skeleton to your new repository. Create a new project under the milvum-modules group. Copy/remember the project URL, you will need it later on. If you didn't clone this repository yet, you should. Now use Git Bash or Terminal to navigate to the root of the skeleton folder. Now execute the init script using ./init_remote_skeleton.sh. Follow the script instructions and you're ready to make your awesome node module instantly. NOTE If you have problems executing the script, try chmod +x ./init_remote_skeleton.sh. Otherwise have fun :).

Warnings

The skeleton is using ES6 , this can cause problems on browser-based applications. In that case use ES5. The ES5 skeleton should also be available somewhere.

Me be failin'

Your new project does not have shared runners enabled, therefore the build will always stay on pending. Just go to Settings > CI/CD Pipelines > Enable Shared Runners