Skip to content

Mono-repo containing React components and hooks library, amongst other things

License

Notifications You must be signed in to change notification settings

atelier-saulx/aviato

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A UI component library for building high-quality CMS & DMS interfaces and web apps.

Repo status Maintenance MIT license


🔍 Description

Aviato's goal is to be a React components and hooks library with focus on usability, accessibility and developer experience.

You can use these components either as the base layer of your application, or adopt them incrementally.

Disclaimer: This project is still in it's concept stage. Use at your own risk.


✨ Features

  • 🗳 - A UI suite designed for CMS + DMS interfaces and web applications.
  • 📦 - A set of high-quality React components out of the box.
  • 🛡 - Written in TypeScript with predictable static types.
  • 🪝 - Contains a comprehensive collection of React Hooks.
  • 🌙 - Dark theme support out of the box.

🖥 Environment Support

  • Modern browsers. Evergreens.
  • Supports both Client-side and Server-side Rendering (CSR & SSR).

📦 Public Packages

Name Description NPM
@aviato/ui Component library & hooks. A suite of ready-to-use components & theming. npm
@aviato/utils Utility functions to facilitate DX and easier development. npm

🧩 Internal Packages

Name Description
@aviato/eslint Eslint configuration used in all Aviato projects.
@aviato/prettier Prettier configuration used in all Aviato projects.
@aviato/tsconfig Typescript configurations used in all Aviato projects.

📕 Documentation

Visit aviato.design for full documentation and a showcase of Aviatos UI component suite, hooks and utilities.

See how to use the library under Getting Started.

To read more behind the scenes, go to Methodologies.


📡 Installation

yarn add @aviato/ui

# or

npm install --save @aviato/ui

🤝 Contributing

We do not currently accept community-driven code contributions, as Aviato is still in concept phase, but feel free to fork Aviato for your own use. This is subject to change in the future.


✍️ Authors


Credits


License

Licensed under the MIT License, Copyright © 2021-present Saulx.

See LICENSE for more information.