NsdHSO / yail

Programmer Network's official UI library

Home Page:https://yail.programmer.network

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Yail

lint-and-test-pr pages-build-deployment deploy-storybook

🎨Yail's Storybook

Yail is the official UI library of Programmer Network, crafted for developers who prioritize simplicity and efficiency. Embracing a minimalist approach, Yail is now open-sourced to share its straightforward and effective design ethos with the broader community. Here’s what makes Yail stand out:

  • Minimalistic Design: Yail focuses on the essentials to deliver a user-friendly experience free from unnecessary complexity.
  • Tailored with Tailwind-CSS: Integrating Tailwind-CSS, Yail offers intuitive styling options, enabling you to create visually appealing web projects effortlessly.
  • Ease of Maintenance: We prioritize hassle-free maintenance, making Yail as easy to manage as it is to implement.

Originally developed for Programmer Network, we decided to open source Yail due to the growing interest from the community. Whether you're working on small-scale projects or large applications, Yail provides the tools for building elegant, responsive, and accessible UIs with minimal overhead.

For an in-depth look at what Yail offers, the Storybook is a good starting point. It documents the current set of UI components and their usage patterns. You can visit our 🖌️Storybook to review the implemented features and components.

Yail is yet another interface library used by Programmer Network 💻🤓.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js: Use nvm to switch to the version specified in the .nvmrc file. To ensure you're using the correct version of Node.js for this project, run nvm use in the project directory.
  • pnpm: Install pnpm globally with npm install -g pnpm.

Getting Started

To view components in Storybook, which is an open-source tool for developing UI components in isolation, run the following command:

pnpm storybook

Storybook will start at http://localhost:6006, where you can view and interact with the components.

Building the Library

When you're ready to build a production version of the library, run:

pnpm build

This command generates the dist folder containing the production build of Yail.

About

Programmer Network's official UI library

https://yail.programmer.network


Languages

Language:TypeScript 95.7%Language:JavaScript 3.9%Language:CSS 0.3%Language:Shell 0.1%