Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codenteq/interfeys
Interfeys is a design system provided by Codenteq to create a consistent UI/UX for app users.
https://github.com/codenteq/interfeys
components design-system frontend javascript typescript uikit web-components
Last synced: 4 days ago
JSON representation
Interfeys is a design system provided by Codenteq to create a consistent UI/UX for app users.
- Host: GitHub
- URL: https://github.com/codenteq/interfeys
- Owner: codenteq
- License: mit
- Created: 2024-03-05T17:21:01.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-09-20T06:15:09.000Z (14 days ago)
- Last Synced: 2024-09-25T12:12:01.479Z (8 days ago)
- Topics: components, design-system, frontend, javascript, typescript, uikit, web-components
- Language: TypeScript
- Homepage: https://interfeys.codenteq.com
- Size: 1.35 MB
- Stars: 6
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Interfeys Design System
Interfeys is a design system provided by [Codenteq](https://github.com/codenteq) to create a consistent UI/UX for app users.
Web implementation of the design system is created as native web components so it can be used within every type of web frameworks including React. Our target is providing a UI library that has neatly designed and developed for providing best possible user experience for the users of applications that uses Interfeys DS.
## Getting Started
First, install the package:
```bash
npm i @codenteq/interfeys
```
In order for the styles to be applied correctly, you will need to ensure that the path to @codenteq is included in the content field of your `tailwind.config.ts`.
```javascript
'./node_modules/@codenteq/**/*.{js,ts,jsx,tsx}'
```
```typescript
import { Button } from '@codenteq/interfeys';
export function Primary() {
return Interfeys works!;
}
```
## How to contribute
Interfeys Design System is always open for direct contributions. Contributions can be in the form of design suggestions, documentation improvements, new component suggestions, code improvements, adding new features or fixing problems. For more information please check our [Contribution Guideline document.](https://github.com/codenteq/interfeys/blob/master/CONTRIBUTING.md)
## Useful Links
* [Storybook Documentation](https://interfeys.codenteq.com/)