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.
Checkout Live Version: baaymax portfolio
Watch brief video about #Baaymax BaayMax Video
check if
nodejs
andgit
are installed using the below commands.
node --version
# v16.4.2
git --version
# git version 2.35.1.windows.2
If the above requirement are checked
, it time to generate your personal portfolio.
NPM
npm i -g baaymax
YARN
yarn add global baaymax
baaymax
A screen below should be printed out within your terminal
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
.
npm run dev
Open localhost:3000/
within your browser.
you now have your own personal portfolio site ready to use which can now be deployed.
Before running your portfolio, make sure you follow the below instructions
carefully.
Configure your information found in ...data/usersInfo.json
. This file contain your core information about you and some other stuff.
. This can be done after making use of the BAAYMAX_CLI APP
Configure your favorites programming languages
or tools
found in ...data/languages.json
. Go to Devicons.dev select (3) your favorites tools and replace the ones found within this file.
. This can be done after making use of the BAAYMAX_CLI APP
Configure your social accounts found in ...data/socials.json
.
Configure your personal projects
found in ...data/projects.json
.
. This can be done after making use of the BAAYMAX_CLI APP
Configure your personal projects
found in ...confid/index.js
.
BaayMax uses EmailJs a javascript library for sending mails right into your inbox. So do the following.
- Visit https://emailjs.com.
- Create an account.
- Follow the instructions on setting up yours @ https://www.emailjs.com/docs/sdk/installation/. If you feel lost checkout my old Youtube Video where I explain how to send mails using this library. [ Disclaimer: the video was made when I was still a beginner, so take whatever you see as a beginner. ]. Replace the below config with yours, if not, users wont be able to send MESSAGE to your inbox.
Dont forget to setup your Emailjs Template
as shown in the picture, if you feel like adding a different style, also update the template
object found in /components/contact/index.js <line 86:90>
86 const templateParams = {
87 from_name: name,
88 sender_email: email,
89 message: message
90 };
Upload your CV / RESUME
file within the public/CV
folder with the name resume.pdf
just as seen in the picture below.
This can be done by simply updating some of the color codes
found in tailwind.config.js
ALSO, IF YOU FEEL NOTHING CHANGE AFTER MAKING NECESSARY UPDATES, SIMPLY CLEAR
CACHE STORAGE
ALONG WITHLOCALSTORAGE
.
if you run into an
error
kindly post it within the github issue tab here Raise Error