A beautiful, accessible React component library built with Tailwind CSS and Framer Motion, organized as a Turborepo monorepo.
- Modern Stack: Built with React, TypeScript, Tailwind CSS, and Framer Motion
- Beautiful Components: Pre-built components with smooth animations and modern design
- Accessible: Built with accessibility in mind
- Documentation: Comprehensive documentation with live examples
- Monorepo Structure: Organized using Turborepo for optimal development experience
artic-ui/
βββ apps/
β βββ app/ # Documentation site & examples
βββ packages/
β βββ ui/ # Core UI component library
βββ turbo.json # Turborepo configuration
# Clone the repository
git clone https://github.com/yourusername/artic-ui.git
# Install dependencies
npm install
# Start development
npm run devnpm install artic-ui @heroicons/react tailwindcss framer-motionAdd to your tailwind.config.js:
module.exports = {
content: [
'./src/**/*.{js,ts,jsx,tsx,mdx}',
'./node_modules/artic-ui/**/*.{js,ts,jsx,tsx}'
],
// ... rest of your config
}The documentation site is built using Next.js and includes:
- Component examples
- API documentation
- Interactive playgrounds
- Installation guides
- Effect demonstrations
Visit the documentation at: http://localhost:3000 when running locally
- Node.js 18+
- pnpm
- Git
# Start development
pnpm dev
# Build all packages
pnpm build
# Run tests
pnpm test
# Lint code
pnpm lintThe core UI library includes:
- Buttons
- Alerts
- Forms
- Cards
- Modals
- Navigation components
- And more...
Features:
- Interactive component demos
- Live code editing
- Copy-paste ready examples
- Comprehensive API documentation
The project uses Turborepo for efficient build caching and task running:
{
"pipeline": {
"build": {
"dependsOn": ["^build"],
"outputs": [".next/**", "dist/**"]
},
"dev": {
"cache": false,
"persistent": true
}
}
}MIT
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request
import { Button, Alert } from 'artic-ui'
function App() {
return (
<div>
<Button variant="gradient">Click Me</Button>
<Alert
variant="success"
message="Operation successful!"
/>
</div>
)
}- React 18+
- Tailwind CSS 3+
- Framer Motion 10+
- Heroicons 2+
- TypeScript 5+
artic-ui/
βββ apps/
β βββ app/
β βββ src/
β β βββ components/ # Documentation components
β β βββ app/ # Next.js pages
β β βββ styles/ # Global styles
βββ packages/
β βββ ui/
β βββ src/
β β βββ components/ # UI components
β β βββ lib/ # Utilities
β βββ dist/ # Built package
For more detailed documentation, visit the documentation site or refer to the README files in individual packages.
npm install artic-ui @heroicons/react tailwindcss framer-motionAdd to your tailwind.config.js:
module.exports = {
content: [
'./src/**/*.{js,ts,jsx,tsx,mdx}',
'./node_modules/artic-ui/**/*.{js,ts,jsx,tsx}'
],
theme: {
extend: {},
},
plugins: [],
}We welcome contributions to Artic-UI! Whether you want to:
- Add new components
- Improve existing ones
- Fix bugs
- Enhance documentation
- Fork the repository: github.com/hothead01th/artic-ui
- Create your feature branch:
git checkout -b feature/amazing-component - Install dependencies:
npm install - Make your changes
- Test your changes:
npm test - Commit your changes:
git commit -m 'Add amazing component' - Push to the branch:
git push origin feature/amazing-component - Submit a Pull Request
Current version: v0.0.6 Package: artic-ui on npm
import { Button, Alert } from 'artic-ui'
function App() {
return (
<div>
<Button variant="gradient">Click Me</Button>
<Alert variant="success">Operation successful!</Alert>
</div>
)
}For more examples and documentation, visit our documentation site.
This project is licensed under the MIT License. See the LICENSE file for details.