consus-core

Common modules for the Consus project

Installing

npm install consus-core --save

Submodules

• Clone
• Flux
• Identifiers

Developing

Getting Started

# Clone the repository
git clone git@github.com:TheFourFifths/consus-core.git
# Enter the project directory
cd consus-core
# Install dependencies
npm install
# Build the project
npm run build
# Run the test suite
npm test

Development Scripts

• npm test: Run the test suite
• npm run lint: Run the linter
• npm run build: Build the usable .dist directory
• npm run coverage: Generate a code coverage report

Project File Structure

• docs: Project documentation goes here
• src: The project's source code
• test: The project's tests