Skip to content

Commit b82cf8b

Browse files
committed
Docs: ✅ Contribution guide
1 parent 129ca71 commit b82cf8b

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed

CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing to RetroUI
2+
3+
Thank you for your interest in contributing to RetroUI 🙏. I hope this guide to help you get started.
4+
5+
## Getting Started
6+
7+
1. Fork this repository
8+
9+
2. Clone the forked repository to your local machine.
10+
11+
```bash
12+
git clone https://github.com/<YOUR_USERNAME>/retroui.git
13+
```
14+
15+
3. Navigate to the project directory
16+
17+
```bash
18+
cd retroui
19+
```
20+
21+
4. Create a new branch
22+
23+
```bash
24+
git switch -c new-branch-name
25+
```
26+
27+
5. nstall dependencies
28+
29+
```bash
30+
pnpm i
31+
```
32+
33+
6. Run the project
34+
```bash
35+
pnpm dev
36+
```
37+
38+
## Adding a New Component
39+
40+
1. Create the main component in `/components/NewComponent/NewComponent.tsx`
41+
42+
```ts
43+
import React from 'react'
44+
45+
export function NewComponent() {
46+
return (
47+
<div>
48+
This is your component.
49+
</div>
50+
)
51+
}
52+
```
53+
54+
2. Export your component in `/components/NewComponent/index.ts` and `/components/index.ts`
55+
56+
```ts
57+
export * from "./NewComponent"
58+
```
59+
60+
3. Create basic example to showcase your component in `app/page.tsx`
61+
62+
```typescript
63+
import React from "react";
64+
import { H3, NewComponent } from "@/components";
65+
66+
export default function page() {
67+
return (
68+
<div className="container max-w-6xl mx-auto">
69+
<H1>Welcome to RetroUI</H1>
70+
71+
<div className="space-y-8 mt-12">
72+
...
73+
<div>
74+
<H3>New Component</H3>
75+
<NewComponent />
76+
</div>
77+
</div>
78+
</div>
79+
);
80+
}
81+
```
82+
83+
84+
## Ask for Help
85+
For any help or questions, please open a new GitHub issue.

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,12 @@ RetroUI is a retro-styled Tailwind CSS component library for modern web apps.
33

44
![RetroUI banner](./public/banner.png)
55

6+
## Why another UI library?
7+
<iframe width="560" height="315" src="https://www.youtube.com/embed/7goHwy6k3gU?si=ujdg4aRfEPpVuXJ5" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
8+
9+
10+
### [Documentation](https://ui.ariflogs.com/components)
11+
### [Contributing Guide](./CONTRIBUTING.md)
12+
13+
## License
14+
RetroUI Core Version is Free and open-source, both for your personal or commercial projects.

0 commit comments

Comments
 (0)