https://github.com/bittricky/business-card
A command-line business card 🪪
https://github.com/bittricky/business-card
business-card chalk cli javascript nodejs npm npm-package typescript yargs
Last synced: 3 months ago
JSON representation
A command-line business card 🪪
- Host: GitHub
- URL: https://github.com/bittricky/business-card
- Owner: bittricky
- License: mit
- Created: 2024-12-11T19:40:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T00:21:09.000Z (over 1 year ago)
- Last Synced: 2025-03-20T01:22:32.635Z (over 1 year ago)
- Topics: business-card, chalk, cli, javascript, nodejs, npm, npm-package, typescript, yargs
- Language: TypeScript
- Homepage: https://mitulpa.tel
- Size: 567 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Business Card
A command-line business card that displays my contact information and social links.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- [Node.js](https://nodejs.org/) version 14.16 or higher
- [npm](https://www.npmjs.com/) (comes with Node.js) or [yarn](https://yarnpkg.com/) package manager
Note: This package is built with TypeScript and uses modern JavaScript features, so make sure you have a compatible Node.js version installed.
## Installation
You can run this package using npx:
```bash
npx bittricky
```
Or install it globally:
```bash
yarn global add bittricky
```
## Usage
After installing globally, you can use the following commands:
```bash
# Display the business card
bittricky
# Open resume in default browser
bittricky resume
# Open showcase in default browser
bittricky showcase
```
### Options
- `--help`: Show help information
- `--version`: Show version information
## Development
1. Clone the repository:
```bash
git clone https://github.com/bittricky/business-card.git
cd business-card
```
2. Install dependencies:
```bash
yarn install
```
3. Start development mode:
```bash
yarn dev
```
4. Build the package:
```bash
yarn build
```
### Testing
- Run tests: `yarn test`
- Run tests with coverage: `yarn test:coverage`
- Run tests with specific path: `yarn test:path `
## Publishing
You can publish a new version using one of the following commands:
```bash
# Patch version (1.0.0 -> 1.0.1)
yarn publish:patch
# Minor version (1.0.0 -> 1.1.0)
yarn publish:minor
# Major version (1.0.0 -> 2.0.0)
yarn publish:major
```
## License
MIT
@author [Mitul Patel](https://www.mitulpa.tel/)