react-epic-trails-ds

React Epic Trails Design System

Note: This package is currently in early development (v0.0.1). APIs may change frequently.

A flexible and customizable design system for React 18, offering pre-built UI components, typography, and theming capabilities tailored for outdoor and adventure-themed web applications.

🚧 Under Development

This design system is under active development. Many features are planned but not yet implemented. Documentation and examples will expand as we progress.

📦 Installation

npm install react-epic-trails-ds
# or
yarn add react-epic-trails-ds

🚀 Getting Started

import { Button } from 'react-epic-trails-ds';

export default function App() {
  return (
    <div style={{ display: 'flex', justifyContent: 'center', alignItems: 'center', height: '100vh' }}>
      <Button variant="primary">
        Start Exploring
      </Button>
    </div>
  );
}

🛠 Development

To contribute to the design system:

1. Clone the repository

   git clone https://github.com/HimanshuHegde/react-epic-trails-ds.git

2. Install dependencies

   npm install

3. Start the development server

   npm run dev

📚 Current Components

• Buttons: Primary, Secondary variants with multiple sizes (Medium, Large, Docked)
• Tiles: Basic content containers with various visual states

🗺 Roadmap

• Full component library (Inputs, Cards, Modals, etc.)
• Dark/light theme customization
• Accessibility support (WCAG AA+)
• Docs website + examples
• Interactive component playground

📄 License

MIT

👥 Contributors

🤝 How to Contribute

Interested in contributing? Follow our contribution guidelines:

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