When developing npm modules it is a good idea to work in a segregated (virtual) environment. This provides a quick way to get set up without affecting your other projects and machine in general.
This is an optional guide on how you could set up your environment. Once you’re good to go, feel free to clone our extendscriptr boilerplate template.
$ git clone https://github.com/ExtendScript/extendscriptr-boilerplate.git
I recommend using nodeenv. A tool that integrates with virtualenvwrapper to manage isolated nodejs environments.
There is a great guide on how to setup your virtual environment at python-guide.org
When your virtualenv is installed we can create a new environment for a project at the top level (next to your version control directory):
$ virtualenv .venv
So your project folder looks roughly like this:
yourProject
├── .git
│ ├── HEAD
│ ├── config
│ ├── ...
└── .venv
├── bin
├── include
└── lib
Now we are inside the virtual Python environment we can install the Node components.
$ pip install nodeenv
$ nodeenv -p
The Python Package Index no longer supports http connections. You can ignore SSL errors by setting pypi.python.org as the trusted source:
pip install --trusted-host pypi.python.org nodeenv
That's all, Now get to work!
$ workon yourProject
To make things even easier you can install and use our build-node-venv module.
We don't want to commit our virtual environment to git. Therefore it is advised to add the .venv folder to your global ignore file. Feel free to fork my .gitignore_global.
Download and install Docker if you have not allready and pull the official docker-node. The git has some great documentation but if you're after a nicer read check the write-up from Azat Mardan.