@doorventures/doorframe v0.0.4

Doorframe Component Library

🚪 Welcome to the Doorframe Component Library! 🚪

https://www.npmjs.com/package/@doorventures/doorframe

Getting Started

Make sure to have NVM installed.

Installing NVM

Platform-Specific Instructions

Windows 🪟

For Windows users, use the following commands:

1. Download the NVM installer from https://github.com/nvm-sh/nvm/releases.
2. Run the installer and follow the on-screen instructions.

then to get the correct version.

nvm install v18.16.0
nvm use v18.16.0
npm install

Mac 🍎

1. Open a terminal.
2. Run the following command:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

then to get the correct version.

nvm install v18.16.0
nvm use v18.16.0
npm install

Installation

nvm install v18.16.0
nvm use v18.16.0
npm install

Development 👩‍💻

npm run dev

Visit http://localhost:5173 to explore the component playground. 🎉

Building 🏗️

Build the library for the latest changes in the components.

npm run build

This command transpiles TypeScript files to JavaScript, optimizing the code for performance and producing a dist folder with the bundled components.

Testing 🧪

Run tests to ensure the reliability of your components.

npm test

This command executes the test suite and provides feedback on the health of your components.

Version Upgrade 🚀

Increment the library version for changes.

npm version patch

This command bumps the library version, updating the package.json file. Follow Semantic Versioning principles.

Publishing 🌐

Publish your library to npm for others to use.

npm publish

This command uploads your library to the npm registry, making it accessible to the global development community.

🎉 Happy coding with Doorframe components! 🎉