README.md

Getting Started with @tiller-ds/cra-template

The official Tiller template for Create React App.
Designed for highly scalable & performant React applications,
emphasizing the best UX and best practices.

Usage

Initializing with Yarn (preferred):

yarn create react-app %PROJECT_NAME% --template @tiller-ds/cra-template

or with npm:

npx create-react-app %PROJECT_NAME% --template @tiller-ds/cra-template

Then

cd %PROJECT_NAME%
yarn install
yarn start

✨ Features

• 🛡 Supports TypeScript with generated tsconfig.json
• 📦️ Installed Tiller (@tiller-ds/theme & @tiller-ds/core modules)
• 🎨 Initial theme setup in /styles/tillerConfig.tsx
• 📌 Supports TailwindCSS
• 📌 Supports Phosphor Icons (If desired, the icon set can be modified within /styles/tillerConfig.tsx file. Click here for more.)
• 📌 React Router v6

🎨 Tiller Design System - Figma UI Kit

Tiller DS UI kit in Figma is a collection of Tiller components that allow you to easily create user interfaces for your Figma projects. It includes common components like buttons, input fields, and menus, as well as more specialized components, like Formik components or Login Pattern.

• Figma UI Kit

📚 Tiller Docs & Storybook

For more information about Tiller Design System, please refer to:

• Storybook
  • Usage documentation for each component
  • Prop documentation for each component
  • Factories for a number of components to easily visualize and create components
  • Code preview for each story
• GitHub
• npm

🙌 Contributing

The contributions are most welcome. We would appreciate contributions from the community, regardless of their size. 😍

If you're interested, definitely check our Contributing Guide.