DoodleUI

A minimalistic UI component library with a doodle style

Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Authors

About The Project

Hi, I'm Siya and this is DoodleUI. It's my project where I combine my love for doodle art with web development. In this library, I've created a bunch of components using React.js and SCSS. They're simple, fun, and have that doodle style I really like.

I made DoodleUI because I noticed there weren't many resources for this kind of design. It's built with React, Rollup & Storybook, which I found to be a great combination for this work. The project isn't open for contributions at the moment, but feel free to let me know about any bugs or things you think would be cool to add.

DoodleUI is something I'm sharing on specific terms, so if you're interested in using it, just check with me first.

Built With

In building DoodleUI, I've utilized a mix of technologies that I find effective and enjoyable to work with. The core is built on React, giving the components their interactive edge. For styling, I've leaned into Sass for its flexibility. Typescript is in play too, ensuring more robust coding. Rollup helps bundle everything neatly, and Storybook makes it easier to visualize and test the components. Together, these technologies bring DoodleUI to life.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/siyabendoezdemir/DoodleUI.git

2. Install NPM packages

npm install

3. Run the project in Storybook

npm run storybook

Usage

DoodleUI can be used in any project and for any purpose. Before you use it however send me a quick email and tell me about your project and why you want to use DoodleUI. 😄

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Currently I am not open to contributions for DoodleUI. Feel free to create requests for new components and features or to report bugs and issues.

License

As of right now DoodleUI is not open to the general public, therefore I ask you to please contact me before using it in your project.

Authors

• Siyabend Özdemir - Front-End Developer - Siyabend Özdemir - Founder and developer behind DoodleUI