sanvarov

Sal's npx Business Card

A npx business card built with 💙 and ☕ by Sal Anvarov.

Table of Contents:

1. Description
2. Prerequisites
3. Deployment
4. Repository Files and Folders

📚 Description

Preview this by typing in the following command in your terminal:

npx sal-anvarov

This is a npx business card that I created to connect with other developers programmatically.

---

🛠️ Prerequisites

Non Docker

• Please make sure to have Node.js (16+) locally by downloading the Javascript runtime via brew, choco, or apt-get.

Docker 🐳

• Please make sure to have Docker Desktop operational to quickly compose the required dependencies. Then follow the docker procedure outlined below.

---

🚀 Deployment

Manual Deployment without Docker

• Clone the repo via git clone https://github.com/msanvarov/npx-business-card.

• Navigate to the root directory of repo via cd npx-business-card.

• Download dependencies via npm i or yarn.

• Start the cli app in development mode via npm run dev. To start in production mode, run npm run build and then npm start.

Deploying with Docker 🐳

Open in Docker Dev Environments

• Execute the following command in-app directory:

# creates and loads the docker container in detached mode with the required configuration
$ docker-compose up -d

---

📁 Repository Files and Folders

.
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── sal-cv.html
├── src
│   └── index.ts
└── tsconfig.json

---

🏗️ Progress

Branches	Status
main	✅
feat/*	🚧

---

👥 Help

PRs are appreciated, I fully rely on the passion ❤️ of the OS developers.

---

License

This personal portfolio website is MIT licensed.

Author