VEAMS One tool to build fast, scalable, flexible & best practices driven web apps.

Install CLI

With NodeJS in place you can easily install the CLI. Just execute the following in your terminal:

npm install -g @veams/cli

That’s it! You want to deep dive into the installation process? Then follow our docs.

Create and Start a Project.

By executing veams new project you can create a customized project. Just follow the prompts and after a couple of minutes you are ready to go.

After the installation process, you only need to start the project with:

npm run start

Open up your favorite browser and go to http://localhost:3000.

Install Components

VEAMS provides a lot of components for you. You want to use them right away?

Here you go. Open up another terminal and install a component right into your project:

veams install @veams/component slider

After that you get a nice looking documentation with all slider variations in place.

Generate Custom Components

You want to create a component from scratch? No problem at all!

VEAMS gives you the flexibility to create components based on what we called blueprints. You can see the default blueprint in action by executing:

veams generate component my-first-component

Answer the prompts and you can start to work with your first VEAMS component.