README.md

card-flex

📋 description

card-flex is cli tools to generate cli-based name-card.

---

💻 how to setup

on your local machine

Note

VIDEO - how to : setup card-flex locally

before we get started, please note that you have to install nodejs including npx to run this cli-tools.

• first, open your terminal and run the following command to initialize the project:

npx card-flex

• the previous command will prompt you with a series of questions. answer them as required to configure your name-card
• make sure there's no error. if you get an error, please write on this link
• it will create new folder/directory based on your GitHub username that you provide before
• change the directory using this command

cd <your-github-username>

• open your name-card locally using

npm run dev

you should be able to see your own cli-based name-card locally

---

---

public on "npmjs"

Note

VIDEO - how to : npm login
VIDEO - how to : npm publish
VIDEO - how to : check the package on npmjs.com
VIDEO - how to : access your card-flex public using npx

next step we will make it public using npmjs.com, so people can access your cli-based name-card by using npx <your-github-username>.
if don't have an account, you need to register it first to npmjs.com, don't forget to use your github username as npmjs username

• open your terminal and login to your npmjs

npm login

• follow the prompt to login to your account
• once that is done, go ahead and run an

npm publish

• make sure there's no error. if you get an error, please write on this link

• if everything is set up right, try running

npx <your-github-username>

---

🛠️ advance usage

you can fully customize your own card, click here to learn more

---

🖼️ showcase

show me your-own card-flex by posting it on this showcase your card

---

💪 support me

---

🤝 thanks to

this project was inspired by Tierney Cyren and Okafor Irene

---