https://github.com/simobin/portable-nodejs-workspace
This repository serves as a template for quickly setting up a portable Node.js development environment for vs code
https://github.com/simobin/portable-nodejs-workspace
node node-js node-module npm portable portable-workspace vscode
Last synced: about 2 months ago
JSON representation
This repository serves as a template for quickly setting up a portable Node.js development environment for vs code
- Host: GitHub
- URL: https://github.com/simobin/portable-nodejs-workspace
- Owner: siMobin
- Created: 2023-09-16T07:39:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T08:35:33.000Z (about 1 year ago)
- Last Synced: 2025-04-09T09:36:20.439Z (about 1 year ago)
- Topics: node, node-js, node-module, npm, portable, portable-workspace, vscode
- Language: PowerShell
- Homepage:
- Size: 28.1 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Template Repository
A Portable Node.js workspace
## Introduction
This repository serves as a template for quickly setting up a portable Node.js development environment. Whether you're starting a new project or need a clean, consistent development environment across multiple machines, this template will help you get up and running in no time.
### Features
- Pre-configured Node.js environment
- Portable setup for use on **windows** machines
- Easy-to-follow setup instructions
- Other workspace settings:
- PHP server
- PHP
- prettier
- cSpell checker
- liveserver
- live sass compiler
[](https://your-project-url)
[](https://your-project-url)
**ON** _[15/10/2023](https://github.com/siMobin/Portable-NodeJS-Workspace)_...
## Getting Started
Follow these steps to set up your portable Node.js development environment using this template repository:
### Prerequisites
- **Git:** Install `Git` on your system if it's not already installed. You can download Git from _[git-scm.com](https://git-scm.com/)_.
- **Visual Studio Code:** Install `Visual Studio Code` on your system if it's not already installed. You can download it from _[code.visualstudio.com](https://code.visualstudio.com/download)_.
> [!IMPORTANT]
> This portable workspace works on **vs code** only.
### Cloning the Repository
Clone this repository to your local machine:
```shell
git clone git@github.com:siMobin/Portable-NodeJS-Workspace.git
git lfs install
git lfs pull
```
> [!WARNING]
> You may need a `ssh` key for that. You can try `HTTPS` then.
> [!IMPORTANT]
> Delete `.git` folder before create a new repository using **_[this](https://github.com/siMobin/Portable-NodeJS-Workspace)_** template.
OR
Use 
to create an instant repository.
##
---
### Setting Up Your Project
check portable environment variable for **Node js** in `.vscode\settings.json`
```json
"terminal.integrated.env.windows": {
"PATH": "${env:PATH};${workspaceFolder}\\node"
},
```
1. Change the working directory to your project folder:
2. Install project dependencies:
```shell
npm init
npm install `xxx` -save-dev
```
> [!IMPORTANT]
> Before start your project check/setup `.gitignore` file.
##
### **Extra**
**update node**
```shell
nvm install x.x.x
```
**update npm**
```shell
npm update -g
```
_OR_
```shell
npm install npm@latest -g
```
**Clear npm cache**
```shell
npm cache clean --force
```