It brings everything you need to create modern web applications on top of modern frameworks.
This monorepo is where all the development happens. Only contributor should need to clone it, if you want to create an app with Vulcan:
See Vulcan docs for detailed documentation: https://vulcan-docs.vercel.app/
After you've read the README, also check the contribution documentation for more information about contributions.
packagesand starter apps in
Lerna is officially deprecated. Instead we are progressively replacing it with Yarn 2 workspaces.
# 1. Install Node 16.10+, then: corepack enable yarn set version stable
Plugins are already installed, since some parts of the ".yarn" folder are stored in the repo (Yarn executable, plugins etc.)
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.
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:
yarn run publish:local
We use Yalc and not
yarn link because linking is not sufficient, it raises a lot of issues with locally installed packages.
@vulcanjs/xxx will be available in your own application.
To use a testing database on windows, you could encounter an unexpected issue ; a solution is to download Visual C++ redistribuable. See https://github.com/nodkz/mongodb-memory-server/issues/475
Best solution is to use a dockerized Mongo instead or stick to Ubuntu 20.
Generated using TypeDoc