Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 2.55 KB

README.md

File metadata and controls

117 lines (79 loc) · 2.55 KB

Ezsnipe (Ezsnipete) - Component & Backend Delivery Network

Ezsnipe is a powerful component and backend file delivery network that allows developers to easily integrate UI components and backend modules into their projects with a simple CLI command. saving time and streamlining development.

🚀 Features

✅ Install UI components effortlessly
✅(Building..) Add backend modules alongside UI components
✅(Building..) Supports multiple frameworks & libraries
✅ Simple CLI for easy integration

📦 Installation

To install Ezsnipe, use npm:

npm install -g ezsnipe

Verify installation:

npx ezsnipe --version

🔧 Usage

Adding a Component

To install a UI component from the Ezsnipe registry:

npx ezsnipe add <component-name>

Example:

npx ezsnipe add bento-grid

This will download the Bento Grid component and place it in your project.

Adding a Backend Module

(Building..) Ezsnipe supports backend files too. To add a backend module:

npx ezsnipe add <module-name>

Example:

npx ezsnipe add auth-middleware

This will install an authentication middleware into your backend.

List Available Components

To see all available components and backend modules: (Building..)

npx ezsnipe list

🛠 Configuration (Building..)

You can configure Ezsnipe by creating a .ezsniperc file in your project root.

Example .ezsniperc file:

{
  "defaultDirectory": "components/ui",
  "backendDirectory": "server/modules"
}

This ensures all UI components go inside components/ui and backend modules into server/modules.

📜 Example Project Structure

After installing a few components, your project may look like this:

/my-project
 ├── /components
 │   ├── /ui
 │   │   ├── BentoGrid.tsx
 │   │   ├── Footer.tsx
 │   │   ├── Button.tsx
 ├── /server
 │   ├── /modules
 │   │   ├── authMiddleware.ts
 │   │   ├── loggingMiddleware.ts
 ├── .ezsniperc
 ├── package.json

🔄 Updating Ezsnipe

To update Ezsnipe to the latest version:

npm update -g ezsnipe

🤝 Contributing

Want to add your own components to Ezsnipe? You can submit your component to the registry by opening a pull request in our GitHub repository.

❤️ Support

For issues, bug reports, or feature requests, please open an issue on GitHub.