# simulation-platform

> EquitySim's Simulation Platform

Latest version **6.8.15** (published 2020-09-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install simulation-platform
pnpm add simulation-platform
yarn add simulation-platform
bun add simulation-platform
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.8.15 |
| Published | 2020-09-04 |
| First published | 2020-09-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8.0 |
| Dependencies | 47 |
| Unpacked size | 3.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | EquitySim Canada Inc. |
| Maintainers | pjwiebe |

## Links

- npm: https://www.npmjs.com/package/simulation-platform
- Repository: https://github.com/equitysim/simulation-platform
- Homepage: https://github.com/equitysim/simulation-platform#readme
- Issues: https://github.com/equitysim/simulation-platform/issues
- npm.io page: https://npm.io/package/simulation-platform

## Dependencies (47)

- [react](https://npm.io/package/react.md) ^16.8.6
- [redux](https://npm.io/package/redux.md) ^4.0.1
- [slate](https://npm.io/package/slate.md) ^0.47.4
- [moment](https://npm.io/package/moment.md) ^2.22.1
- [core-js](https://npm.io/package/core-js.md) ^2.5.5
- [env-cmd](https://npm.io/package/env-cmd.md) ^7.0.0
- [history](https://npm.io/package/history.md) ^4.7.2
- [reselect](https://npm.io/package/reselect.md) ^3.0.1
- [hook-book](https://npm.io/package/hook-book.md) 0.0.1-beta.20
- [immutable](https://npm.io/package/immutable.md) ^4.0.0-rc.12
- [is-hotkey](https://npm.io/package/is-hotkey.md) ^0.1.4
- [logrocket](https://npm.io/package/logrocket.md) ^0.6.16
- [plotly.js](https://npm.io/package/plotly.js.md) ^1.52.2
- [react-dom](https://npm.io/package/react-dom.md) ^16.8.6
- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.10.5
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.2
- [react-pose](https://npm.io/package/react-pose.md) ^4.0.1
- [sw-toolbox](https://npm.io/package/sw-toolbox.md) ^3.6.0
- [react-redux](https://npm.io/package/react-redux.md) ^7.0.2
- [slate-react](https://npm.io/package/slate-react.md) ^0.22.4
- [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) ^2.0.4
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.10.5
- [lodash.isequal](https://npm.io/package/lodash.isequal.md) ^4.5.0
- [lodash.ismatch](https://npm.io/package/lodash.ismatch.md) ^4.4.0
- [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8
- [logrocket-react](https://npm.io/package/logrocket-react.md) ^3.0.0
- [moment-timezone](https://npm.io/package/moment-timezone.md) ^0.5.20
- [react-plotly.js](https://npm.io/package/react-plotly.js.md) ^2.2.0
- [lodash.clonedeep](https://npm.io/package/lodash.clonedeep.md) ^4.5.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.0.0
- [@equitysim/common](https://npm.io/package/@equitysim/common.md) 0.0.24
- [lodash.differenceby](https://npm.io/package/lodash.differenceby.md) ^4.8.0
- [@equitysim/common-fe](https://npm.io/package/@equitysim/common-fe.md) 0.1.42
- [@equitysim/code-style](https://npm.io/package/@equitysim/code-style.md) ^0.0.13
- [react-stripe-checkout](https://npm.io/package/react-stripe-checkout.md) ^2.6.3
- [react-stripe-elements](https://npm.io/package/react-stripe-elements.md) ^4.0.0
- [request-idle-callback](https://npm.io/package/request-idle-callback.md) ^1.0.2
- [@equitysim/react-uikit](https://npm.io/package/@equitysim/react-uikit.md) 2.0.18
- [connected-react-router](https://npm.io/package/connected-react-router.md) ^6.4.0
- [prop-type-conditionals](https://npm.io/package/prop-type-conditionals.md) 0.0.11
- [react-loading-skeleton](https://npm.io/package/react-loading-skeleton.md) ^2.0.1
- [react-transition-group](https://npm.io/package/react-transition-group.md) ^4.1.1
- [@tonydinh/react-toolkit](https://npm.io/package/@tonydinh/react-toolkit.md) ^1.0.0-rc.17
- [hoist-non-react-statics](https://npm.io/package/hoist-non-react-statics.md) ^3.3.0
- [redux-devtools-extension](https://npm.io/package/redux-devtools-extension.md) ^2.13.8
- [babel-plugin-add-react-displayname](https://npm.io/package/babel-plugin-add-react-displayname.md) 0.0.5

## Recent versions

- 6.8.15 (latest) — 2020-09-04

## README

# Simulation Platform

## Getting Started

### Requirements
1. Node 8.7.0+ (we recommend using `nvm` to manage node versions)
1. NPM 5.4.2

### Development
In order to To start up the development server, run the following command in project directory root (you may exclude *'nvm use && '* if you don't have nvm installed):

```sh
$ nvm use && npm i && npm start
```

This will install all defined module dependencies into a `/node_modules` folder and start the development server (`localhost:9000` by default).

NOTE for `npm link`ing of `react-uikit` you must first go to the react-uikit directory and:

```sh
$ npm link ../simulation-platform/node_modules/react
```

otherwise you will not be able to run the development server without it telling you that there are multiple instances of React being used.

## Distribution

### Building Bundles
The project is set up to create builds for `production`, `staging`, and `qa` environments.
To build a bundle, run one of the following commands:
```sh
# Build a production bundle
$ npm run build:prod

# Build a staging build
$ npm run build:dev

# Build a qa bundle
$ npm run build:qa
```

This will inject the appropriate environment variables defined in the [.env-cmdrc](./.env-cmdrc) file, bundle the project dependencies, transpile the source code, and output the build into `/build`.

**NOTE:** You can visually analyze a bundle by adding the following flag to your build command `-a | --analyze`.
```sh
$ npm run build:prod -- --analyze
```

### Testing
To run unit tests for the project, run the following command:
```sh
$ npm test
```

A task runner will scan the project for `test.js` files and execute the tests.

## Other
Additional commands can be located in the [package.json](./package.json) file

---
_Source: https://npm.io/package/simulation-platform · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
