@energyaspects/eagle-springs v4.1.1

Eagle Springs

Energy Aspects reusable JavaScript modules.

Production usage

eagle-springs is deployed to NPM as a private package scoped to the @eneryaspects organisation.

To be able to install this project as a npm dependency you will need to setup a npm account that has been given access to read from the @energyaspects organisation.

• Run npm login.
• Enter your npm username, password and email address as prompted.
• To install this project as a dependency type npm install --save @energyaspects/eagle-springs

Development

You can use npm link to make local changes eagle-springs without having to publish a new version to npm.

In your terminal:

• Checkout the source code git clone git@github.com:energyaspects/eagle-springs.git
• Run npm start and wait for successful compilation. This will also start webpack in watch mode.
• In a seperate terminal window while in the root of the eagle-springs project run npm run setup-link.
• Then navigate to the root of the project that will have or has eagle-springs as a dependency.
• Type npm link @energyaspects/eagle-springs

Changes made to eagle-springs components will now persist into the application consuming eagle-springs. While npm start is running you can also run these commands at the same time to assist with development.

• npm run storybook - Runs storybook on a seperate port.
• npm test:watch - Runs Jest in watch mode.

Publishing to npm

You will need an npm account that has write access to the @energyaspects organisation on npm.

Things to note:

• Always publish from master.
• Always change the version number in your PR before merging into master.

Steps to publish:

• Ensure you are on the master branch.
• Ensure the version number in the package.json is appropriate and has been updated (attempting to publish a with an existing version number will fail).
• Login to npm with your npm account as described above.
• Run npm run build-and-publish

A new version of eagle-springs will now be able to install as a private npm dependency.