Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
68 lines (44 loc) · 910 Bytes

DEVELOPMENT.md

File metadata and controls

68 lines (44 loc) · 910 Bytes

Development

Requirements

  • Node.js 8.0+
  • Npm 5.0+

NOTE: we recommend using nvm

brew install nvm
nvm install 8.11
nvm use 8.11

Setup

git clone https://github.com/serverless/components.git
cd components
npm install

USE_ESNEXT environment variable

You can export the USE_ESNEXT environment variable if you're using a Node.js version >=8 and want to work on the project without building / watching it.

Build

To build the project

npm run build

Watch

To automatically re-build the project when files change

npm run watch

Cleanse

To wipe out all installed modules as well as package-lock.json files, use the cleanse script.

To cleanse the project

npm run cleanse

Tests

Run tests for the project

npm test

Lint

Run lint for the project

npm run lint