This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
8.17.0
v18.18.0
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Start with cloning this repo on your local machine:
$ git clone https://github.com/ORG/PROJECT.git
$ cd PROJECT
For Windows users in packege.json:
"scripts": {
"start": "set NODE_PATH=./dist && node ./dist/index.js",
"dev": "nodemon",
"build": "del /S /Q dist && tsc -p tsconfig.json",
"prod": "npm run build && npm run start"
},
To install run:
$ npm install
$ npm run build
This task will create a distribution version of the project
inside your local dist/
folder
After this, project opens at http://localhost:7000 If not, just open a new tab in your browser and paste there