Vulcan NPM

Contribute

For faster development, you may instead want to contribute to Vulcan Next Starter. NPM packages will be published in this repo when they reach sufficient maturity.

After you've read the README, also check ./CONTRIBUTE.md for more information about contributions.

See Vulcan Next for detailed documentation: https://github.com/VulcanJS/vulcan-next

Install Vulcan NPM and start coding

Please use Yarn

yarn # will install + bootstrap learn
yarn run build # build all packages

Now you can either run Storybook yarn run storybook or unit tests yarn run test and start working.

Plug to another local application

If you want to connect your local Vulcan NPM install to an existing application, please check Vulcan Next documentation.

It's a 2 step process:

you publish the packages locally using Yalc yarn run local-publish
you install them, using Yalc, in your app.

We use Yalc and not yarn link because linking is not sufficient, it raises a lot of issues with locally installed packages.

Now @vulcanjs/xxx will be available in your own application.

Windows

To use a testing database on windows, you could encounter an unexpected issue ; a solution is to download Visual C++ redistribuable. See typegoose/mongodb-memory-server#475

Resources