Skip to content

Commit

Permalink
update README and package info
Browse files Browse the repository at this point in the history
  • Loading branch information
@maany
maany committed Apr 20, 2024
1 parent 6d70f65 commit 10d141a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 119 deletions.
146 changes: 31 additions & 115 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,82 +1,32 @@
# React Component Library Starter Kit
# PRADA RAge UI Kit

This template provides a extensive setup to create a component library of React Components.

This template comes with the following technologies configured and ready to go:
- [React](https://reactjs.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Vite](https://vitejs.dev/)
- [Vitest](https://vitest.dev/)
- [Storybook](https://storybook.js.org/)
- Automated CI testing, linting, formatting and coverage with GitHub Actions
- Release automation with GitHub Actions and publishing to NPM
- GitHub Pages Dashboard with API Docs, Storybooks and Test Coverage
- Automatic Documentation Generation with [TypeDoc](https://typedoc.org/)
- [Winston](https://github.com/winstonjs/winston) for logging. There is a logging utility that can be used to log to the console

## Getting Started

Begin via any of the following:

- Press the "*Use this template*" button

- Use [degit](https://github.com/Rich-Harris/degit) to execute:

```
degit github:dream-aim-deliver/dad-ui-components-starter-template
```

- Use [GitHub CLI](https://cli.github.com/) to execute:

```
gh repo create <name> --template="https://github.com/dream-aim-deliver/dad-ui-components-starter-template"
```

- Simply `git clone`, delete the existing .git folder, and then:

```
git init
git add -A
git commit -m "Initial commit"
````

## Customizing the Template

Please go through the following checklist to ensure you have configured the template correctly:

- [ ] Push your code to a new GitHub repository.
- [ ] Update the test coverage thresholds in the `vite.config.ts` file.
- [ ] Remember to use `npm search <term>` to avoid naming conflicts in the NPM Registry for your new package name.
- [ ] Update the `package.json` file with your package `name`, `version`, `description`, `author` and `repository` information.
- [ ] Add or update the `LICENSE` file.
- [ ] In the GitHub repository, go to the "*Settings*" tab and select "*Pages*" section. Then select the source as "*Github Actions*".
- [ ] Generate a new [NPM Access Token](https://docs.npmjs.com/creating-and-viewing-access-tokens).
- [ ] [Create a secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) in the GitHub repository called `NPM_TOKEN` with the value of the npm access token from the previous step.
- [ ] Update the `README.md` file by replacing <MY_COMPONENT_LIBRARY> with the name of your component library. Also, please update the `href` to point to your GitHub Pages URL.
- [ ] Please read and update the [Contributing Guidelines](./CONTRIBUTING.md) before contributing to this project.
- [ ] Please go through the [Release Guidelines](./RELEASE_GUIDELINES.md) before releasing a new version of this project.
- [ ] Please make sure your developers have read the [Development Guidelines](./DEVELOPMENT_GUIDELINES.md) before starting development.
- [ ] Please remember to define the theme of your component library (colors, shades, fonts, animations, breakpoints etc..) in the `lib/tailwind/config.ts` file.
- [ ] Once you have completed the above steps, you can delete the contents of this `README.md` file from here above. Please add any additional information about your component library at the end of this README. This file is used to generate the homepage for your NPM Package on npmjs.com and is also the homepage for your TypeDoc dashboard.

## Add-On Resources
### Picking a Color Palette

When picking a color palette for your component library, consider using a tool like [Coolors](https://coolors.co/) to generate a color palette. You can then define the colors in the `lib/tailwind/config.ts` file.
The template ships with a default color palette that you can use as a starting point, but you should customize it to match your brand.
[![Picking a Color patelle](https://img.youtube.com/vi/yYwEnLYT55c/0.jpg)](https://www.youtube.com/watch?v=yYwEnLYT55c)

### Icons

You can use [Heroicons](https://heroicons.com/) to find icons for your component library. You can then use the `Icon` component in the template to render the icons in your components.
Another great resource for icons is [Lucide Icon](https://lucide.dev/icons/) and [Radix Icons](https://www.radix-ui.com/icons).


### Working with other UI Libraries/Components

We can recommend [Radix UI](https://www.radix-ui.com/), [Shadcn](https://ui.shadcn.com/) as a great resource for building accessible and composable UI components. You can use these components in your component library to build more complex components.
<div style="text-align:center;">

<table style="border:1px solid #ccc; border-collapse: collapse; width:100%;">
<tr>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/">
<img src="https://bischrob.github.io/images/githubpages/githubpages.jpeg" alt="Github Pages" width="100px" style="border-radius: 10px;">
</a>
</td>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/storybook">
<img src="https://storybook.js.org/images/logos/icon-storybook.png" alt="Storybook" width="100px" style="border-radius: 10px;">
</a>
</td>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/docs">
<img src="https://user-images.githubusercontent.com/21266147/101224549-386fb400-368f-11eb-8390-6db2ecd1fe61.png" alt="Docs" height="100px" style="border-radius: 10px;">
</a>
</td>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/coverage">
<img src="https://vitest.dev/logo.svg" alt="Coverage" width="100px" height="100px" style="border-radius: 10px;">
</a>
</td>
</tr>
</table>
</div>

## Usage
The component library built with this template can be used in any project that supports TailwindCSS. After publishing your component library to NPM, you can install it in your project by running:
Expand All @@ -90,7 +40,7 @@ You should then configure the `tailwind.config.js` file in your project to inclu
First, import the tailwind config exported from the component library:

```js
import { defaultTheme } from "<my-component-library>";
import { defaultTheme } from "@maany_shr/rage-ui-kit";
```

Then, include the theme in your project's `tailwind.config.js` file:
Expand All @@ -111,7 +61,7 @@ Additionally, modify the `content` array in the Tailwind Config to include the c
```js
export default {
content: [
"node_modules/<my-component-library>/dist/**/*.js",
"node_modules/@maany_shr/rage-ui-kit/dist/**/*.js",
...other sources
],
theme: {
Expand All @@ -126,39 +76,5 @@ export default {
Then you can import and use the components in your project:

```tsx
import { Button } from '<my-component-library>';
```


---
Your README.md Content goes here:

# <MY_COMPONENT_REPOSITORY>

<div style="text-align:center;">

<table style="border:1px solid #ccc; border-collapse: collapse; width:100%;">
<tr>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/">
<img src="https://bischrob.github.io/images/githubpages/githubpages.jpeg" alt="Github Pages" width="100px" style="border-radius: 10px;">
</a>
</td>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/storybook">
<img src="https://storybook.js.org/images/logos/icon-storybook.png" alt="Storybook" width="100px" style="border-radius: 10px;">
</a>
</td>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/docs">
<img src="https://user-images.githubusercontent.com/21266147/101224549-386fb400-368f-11eb-8390-6db2ecd1fe61.png" alt="Docs" height="100px" style="border-radius: 10px;">
</a>
</td>
<td style="padding:10px; border:1px solid #ccc; text-align:center;">
<a href="https://dream-aim-deliver.github.io/dad-ui-components-starter-template/coverage">
<img src="https://vitest.dev/logo.svg" alt="Coverage" width="100px" height="100px" style="border-radius: 10px;">
</a>
</td>
</tr>
</table>
</div>
import { Button } from '@maany_shr/rage-ui-kit';
```
8 changes: 4 additions & 4 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@maany_shr/dad-ui-components-starter-template",
"version": "1.0.0-beta",
"name": "@maany_shr/rage-ui-kit",
"version": "1.0.0-alpha",
"author": "Mayank Sharma <[email protected]>",
"homepage": "https://dream-aim-deliver.github.io/dad-ui-components-starter-template",
"homepage": "https://dream-aim-deliver.github.io/maany/rage-ui-kit",
"private": false,
"type": "module",
"main": "dist/index.js",
Expand All @@ -13,7 +13,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/dream-aim-deliver/dad-ui-components-starter-template"
"url": "https://github.com/dream-aim-deliver/maany/rage-ui-kit"
},
"sideEffects": [
"**/*.css"
Expand Down

0 comments on commit 10d141a

Please sign in to comment.