0.0.2 ā€¢ Published 8 months ago

sanvarov v0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
8 months ago

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

BranchesStatus
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