Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@
"clsx",
"fullstacksjs",
"mobily",
"Shadcn",
"tailwindcss",
"tsbuildinfo",
"tseslint",
"typecheck"
],
"language": "en",
"ignorePaths": ["node_modules", "pnpm-lock.yaml"]
"ignorePaths": [
"node_modules",
"pnpm-lock.yaml"
]
}
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
Here’s a **README.md** file for your `anotherUI` project:
# AnotherUI

---

# anotherUI
AnotherUI is a UI component library built on top of **Shadcn** and **Tailwind CSS**. This project is designed only for learning purpose and it's open to contributions for people like me who want to learn how implement a simple library with React.

A modern UI component library built with **Vite**, **pnpm**, and **Tailwind CSS**. This project is designed to be developer-friendly, customizable, and open to contributions.

## Table of Contents
## Table of Contents 📃

- [Folder Structure](#folder-structure)
- [Tech Stack](#tech-stack)
Expand All @@ -19,7 +15,7 @@ A modern UI component library built with **Vite**, **pnpm**, and **Tailwind CSS*

---

## Folder Structure
## Folder Structure 📂

The project structure is organized as follows:

Expand All @@ -41,15 +37,15 @@ The project structure is organized as follows:

---

## Tech Stack
## Tech Stack ⚙️

- **Vite**: Build tool for fast and optimized development.
- **pnpm**: Efficient package manager for monorepos.
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development.

---

## Prerequisites
## Prerequisites 🛒

To work on or use this project, ensure you have:

Expand All @@ -66,7 +62,7 @@ To work on or use this project, ensure you have:

---

## Installation
## Installation 💾

1. Clone the repository:

Expand All @@ -88,7 +84,7 @@ To work on or use this project, ensure you have:

---

## Using anotherUI in Your Project
## Using anotherUI in Your Project ⛓️‍💥

To integrate this library into your project:

Expand Down Expand Up @@ -120,9 +116,9 @@ To integrate this library into your project:

---

## Contributing
## Contributing 🤝

We welcome contributions from the community! Follow these steps to get started:
As I mentioned, This is a personal project, but I welcome contributions from the community! Follow these steps to get started:

1. **Fork the Repository**:

Expand All @@ -132,7 +128,7 @@ We welcome contributions from the community! Follow these steps to get started:

- Create a branch for your changes:
```bash
git checkout -b feature/your-branch-name
git checkout -b your-branch-name
```

3. **Make Changes**:
Expand All @@ -143,7 +139,7 @@ We welcome contributions from the community! Follow these steps to get started:

- Push your branch:
```bash
git push origin feature/your-branch-name
git push origin your-branch-name
```
- Create a Pull Request (PR) to the `main` branch of the original repository.

Expand All @@ -152,7 +148,7 @@ We welcome contributions from the community! Follow these steps to get started:

---

## Commit Guidelines
## Commit Guidelines 🏷️

Follow these commit message conventions (present tense, Linux style):

Expand All @@ -171,9 +167,11 @@ Follow these commit message conventions (present tense, Linux style):
- **Introduce**: For introducing new patterns, plugins, or systems.
Example: `Introduce new token system in twPlugin`

and so on...

---

## Design Tokens
## Design Tokens 🎨

The `twPlugin` directory includes:

Expand Down
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
"name": "another-ui",
"description": "as the name says, it's another ui library for React built on Tailwind & Shadcn",
"author": "Gooddevil",
"version": "0.0.2",
"version": "0.0.3-beta.0",
"type": "module",
"main": "./index.js",
"types": "./src/index.d.ts",
"files": [
"dist/",
"README.md"
],
"keywords": [
"anotherUI,React",
"Tailwind",
Expand Down