BaayMax-Cli 😎

Generating of portfolio site just got easier. BaayMax a tool for developers which enables generating of intuitive, unique, flexible portfolio site ready for deployment.

With just a command, your portfolio is ready.

Getting Started 😎

To get started in using baaymax, make sure Nodejs and Git are preinstalled on your PC.

check if nodejs and git are installed using the below commands.

Git

    node --version
    # v16.4.2

Nodejs

    git --version
    # git version 2.35.1.windows.2

If the above requirement are checked, it time to generate your personal portfolio.

Install BaayMax globally on your pc using any of the below comamnds. 🙌

NPM

    npm i -g baaymax

YARN

    yarn add global baaymax

Check if it installed globally on your pc by running : ✌

    baaymax

A screen below should be printed out within your terminal

Generate your own portfolio. 💖❤

using baaymax --init <project_name> would run you through the setup, kindly follow all instructions carefully.

    baaymax --init portfolio-v3

Once all instructions have been met carefully, you would be prompted to open your portfolio site within vscode. If you have vscode installed as your default editor choose Yes otherwise No.

Start the development server using ✔

    npm run dev

Open localhost:3000/ within your browser.

Congratulation 🎉🎉🎉

you now have your own personal portfolio site ready to use which can now be deployed.

Disclaimer 😢

if you run into an error kindly post it within the github issue tab here Raise Error