# Getting Started

This the standard way to install the project on your machine via npm and serve it from localhost with a self-signed SSL certificate. However you can just run it from "locahost" with yarn dev if you don't want to use a DNS Mask.

# Install cli from npm

Run this command from any folder, it will pull the cli from npm and install it globally.

Valisette avoids using Node's package manager to install the project's dependencies. We use Yarn because it is simpler & built better. So as you run this command valisette installs yarn globally and install your project's dependencies (if you want to re-run install, run npm run start)

# install cli
npm i -g valisette
# create a new project directory
valisette i <project-name>
# or install in existing project directory
valisette i .

# Start DNS Mask

After you've installed DNS Mask valet, make it valet has started to link the project and to run it on https.

# don't paste this line if you've run valet before
valet install
# runs valet service
valet start
# Set valet domains tld to '.app'
valet domain app
cd <valisette-project-directory>
# Serve the boilerplate at https://<valisette-project-directoy-name>.app
valet link
# Enable SSL certification
valet secure

# Re-install project dependencies with Yarn

Just run those basic commands :

cd <project-folder-name>
# installs yarn globally and installs project dependencies
npm run start

# Run your first build

Ok it's time run your first build and see the app !

We use scripts commands to command the boilerplate. All the commands are container in ./package.json but we'll look at those in detail later on.

Let's run your first compilation with :

yarn prod

When the compilation is complete, you should open your browser at https://<project-directory-name>.app/ and add a security exception to validate your SSL certificate (this is normal since we have made a self-signed certificate that we can trust when we installed a DNS Mask).

open https://<project-directory-name>.app

Congratulations you've finished your first Valisette Installation ! 🎉