Skip to main content

Installation

Quick Start​

Overhaul Incoming.

We are working on a complete overhaul of the npx script to be menu based, and allow you to do so much more than just install plexus. Excuse it's current state! (get it? hehe)

If you would like to jump in and start working with plexus right away, you can use our npx script to quickly create a core!

With Yarn
yarn create plexus-core --basic
With NPX
npx create-plexus-core --basic

With Typescript...

With Yarn
yarn create plexus-core --basic --typescript
With NPX
npx create-plexus-core --basic --typescript

Manual Installation​

You can also install PlexusJs manually and create your own core structure. See our Style Guides for more information.

Core Package​

With Yarn
yarn add @plexusjs/core
With NPM
npm install --save @plexusjs/core

React Package​

With Yarn
yarn add @plexusjs/core @plexusjs/react
With NPM
npm install --save @plexusjs/core @plexusjs/react

SolidJS Package (WIP ~ doesn't support events)​

With Yarn
yarn add @plexusjs/core @plexusjs/solid
With NPM
npm install --save @plexusjs/core @plexusjs/solid

NextJS Package​

With Yarn
yarn add @plexusjs/core @plexusjs/react @plexusjs/next
With NPM
npm install --save @plexusjs/core @plexusjs/react @plexusjs/next