reactnativeepictrailsds
Version:
A flexible and customizable design system for React Native, providing pre-built UI components, typography, and themes to enhance mobile app development.
92 lines (66 loc) • 2.73 kB
Markdown
# React Native Epic Trails Design System
[](https://github.com/gaureshpai/reactnativeepictrailsds/blob/main/LICENSE)
[](https://www.typescriptlang.org/)
[](https://github.com/gaureshpai/reactnativeepictrailsds)
> **Note:** This package is currently in early development (v0.0.1). APIs may change frequently.
A flexible and customizable design system for React Native, providing pre-built UI components, typography, and themes to enhance mobile app development with a focus on outdoor and adventure applications.
## Under Development
This design system is currently under active development. Many features are planned but not yet implemented. Documentation and examples will be expanded as development progresses.
## Installation
```bash
npm install reactnativeepictrailsds
# or
yarn add reactnativeepictrailsds
```
## Getting Started
```jsx
import { Button } from 'reactnativeepictrailsds';
export default function App() {
return (
<View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
<Button variant="primary">
Start Exploring
</Button>
</View>
);
}
```
## Development
To contribute to the design system:
1. Clone the repository
```bash
git clone https://github.com/gaureshpai/reactnativeepictrailsds.git
```
2. Install dependencies
```bash
npm install
```
3. Start the development server
```bash
npx expo start
```
## Current Components
- **Buttons**: Primary, Secondary variants in Medium, Large, and Docked sizes
- **Tiles**: Basic content containers with various states
## Roadmap
- Complete component library
- Comprehensive documentation
- Theme customization
- Accessibility improvements
- Interactive examples
- Component playground
## License
[MIT](https://github.com/gaureshpai/reactnativeepictrailsds/blob/main/LICENSE)
## Contributors
<div align="center">
<a href="https://github.com/gaureshpai/reactnativeepictrailsds/graphs/contributors">
<img src="https://contrib.rocks/image?repo=gaureshpai/reactnativeepictrailsds" />
</a>
</div>
## How to Contribute
Interested in joining our team? Check out our [contribution guidelines](CONTRIBUTING.md) to get started!
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 the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request