Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ibnlanre/builder

Repository files navigation

Builder Repository

minified size license version downloads

📦 About This Repository

This is the monorepo for the @ibnlanre/builder library and its documentation. It contains:

  • app/ - The core @ibnlanre/builder library package
  • docs/ - Documentation website built with Nextra

🚀 Quick Start

Installation

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build the library
cd app && pnpm run bundle

# Start the docs dev server
cd docs && pnpm run dev

Development Workflow

Working on the library:

cd app
pnpm run test        # Run tests
pnpm run typecheck   # Type check
pnpm run lint        # Lint code
pnpm run bundle      # Build the library

Working on documentation:

cd docs
pnpm run dev         # Start dev server
pnpm run build       # Build for production

📚 Documentation

For comprehensive guides, API references, and live examples, visit the official documentation:

create-builder.vercel.app

🧪 Testing

The project uses Vitest for testing:

# Run all tests
pnpm test

# Run tests with coverage
pnpm run coverage

# Run tests in watch mode
cd app && pnpm run test -- --watch

📝 Publishing

The library is published to npm from the app/ directory:

cd app

# Patch version (1.0.0 → 1.0.1)
pnpm run patch

# Minor version (1.0.0 → 1.1.0)
pnpm run minor

# Major version (1.0.0 → 2.0.0)
pnpm run major

The publish process automatically:

  1. Runs tests and type checking
  2. Builds the library
  3. Validates package exports with @arethetypeswrong/cli
  4. Publishes to npm
  5. Pushes git tags

🤝 Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (pnpm test)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

📄 License

The @ibnlanre/builder library is licensed under the MIT License.


Built with ❤️ by Ridwan Olanrewaju

About

Dynamic key generation library

Resources

License

Stars

Watchers

Forks

Packages

No packages published