futureuikit
v0.2.4
Published
Future UI component registry and installer CLI for Next.js projects.
Downloads
867
Readme
Future UI - Modern Reusable Components
Future UI is an open-source library of high-performance, visually stunning, and reusable UI components specifically designed for Next.js applications. Built with React 19, Next.js 16, and Tailwind CSS 4, it provides a foundation for building modern, futuristic web interfaces with ease.
🚀 Features
- Modern Tech Stack: Leveraging React 19 and Next.js 16 (App Router).
- Tailwind CSS 4: Optimized styling with the latest Tailwind features.
- Glassmorphism & Glow Effects: Built-in support for futuristic aesthetics.
- Interactive Previews: Live code and preview playground for every component.
- Dark Mode First: Seamless theme switching with persistent storage.
- Performance Optimized: Minimal bundle size and fast load times.
- Open Source: Built by the community, for the community.
🛠 Tech Stack
- Framework: Next.js 16
- Library: React 19
- Styling: Tailwind CSS 4
- Animations: Framer Motion
- Icons: Lucide React
- Typography: Inter & Poppins
💻 Getting Started
Prerequisites
- Node.js: 18.x or later
- npm: 9.x or later (or yarn/pnpm)
Local Setup
Clone the repository:
git clone https://github.com/Aryan3522/future-ui.git cd future-uiInstall dependencies:
npm installRun the development server:
npm run devAccess the library: Open http://localhost:3000 in your browser to explore the components.
CLI Usage
After the package is published to npm, users can install a component with:
npx futureuikit add boxy-bounceThe CLI downloads component files from the registry endpoint configured in package.json:
{
"config": {
"registryUrl": "https://futureuikit.vercel.app/api/registry"
}
}If your production deployment uses a different domain, update config.registryUrl before publishing to npm. You can also override the registry during testing:
npx futureuikit add boxy-bounce --registry https://your-site.vercel.app/api/registryRelease Checklist
- Deploy the Next.js app.
- Verify the registry response:
curl https://futureuikit.vercel.app/api/registry/boxy-bounce - Verify the npm package exposes the CLI:
npm pack --dry-run npm view futureuikit bin - Publish the new version:
npm publish - Validate from npm:
npx futureuikit@latest add boxy-bounce
⚙️ Configuration
Create a .env file in the root directory and add the following variables:
# Project Configuration
NEXT_PUBLIC_APP_URL=http://localhost:3000
FUTURE_UI_REGISTRY_URL=http://localhost:3000/api/registry
NEXT_PUBLIC_GITHUB_REPO=https://github.com/Aryan3522/future-ui
NEXT_PUBLIC_GITHUB_PROFILE=https://github.com/Aryan3522
NEXT_PUBLIC_LINKEDIN_PROFILE=https://www.linkedin.com/in/aryan-hooda-code/🤝 Contributing
Future UI is open-source and we love contributions! Whether you're fixing a bug, adding a new component, or improving documentation, your help is welcome.
How to Collaborate:
- Fork the Project: Click the 'Fork' button at the top right of this page.
- Create a Branch:
git checkout -b feature/amazing-component - Commit your Changes:
git commit -m "feat: Add a new GlassyCard component" - Push to the Branch:
git push origin feature/amazing-component - Open a Pull Request: Go to the original repository and click 'New Pull Request'.
Contribution Guidelines:
- Ensure your code follows the existing style and conventions.
- Add comments where necessary.
- Update the documentation/README if you're adding new features.
- Test your changes thoroughly before submitting.
📜 License
This project is licensed under the MIT License - see the LICENSE file for details.
🌟 Support
If you find this project helpful, give it a ⭐ on GitHub!
Built with ❤️ by Aryan Hooda and the Open Source Community.
