Skip to content

Commit 453dacd

Browse files
authored
Merge pull request #810 from sheikhlimon/docs/add-tech-stack
docs: add Tech Stack and reformat README, update naming consistency (Hive → recode hive)
2 parents bb8a61d + b05c142 commit 453dacd

File tree

4 files changed

+26
-11
lines changed

4 files changed

+26
-11
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ To get started with contributing to recode hive, please refer to our [Contributi
3838
<img style="max-width:700px;" src="https://cdn.loom.com/sessions/thumbnails/c8d8d5f0c2534a1f86fc510dcef52ee0-30cac2eeec09a266-full-play.gif">
3939
</a>
4040
</div>
41-
Follow these steps:
41+
42+
### Follow these steps:
4243

4344
```mermaid
4445
flowchart LR
@@ -80,20 +81,20 @@ flowchart LR
8081

8182
This command will start a development server and open the application in your default web browser.
8283

83-
## Local Development with Docker Compose & Hot Reload
84+
## Local Development with Docker Compose & Hot Reload
8485

8586
For an even smoother experience, contributors can leverage **Docker Compose with hot-reloading**.
8687
This lets you see code changes instantly at [http://localhost:3000](http://localhost:3000) without rebuilding or restarting containers.
8788

88-
### 🏃 Quick Start
89+
### Quick Start
8990

9091
```bash
9192
git clone https://github.com/your-username/recode-website.git
9293
cd recodehive-website
9394
docker-compose up
9495
```
9596

96-
### 🚢 Production Deployment
97+
### Production Deployment
9798

9899
```bash
99100
npm run build
@@ -109,6 +110,20 @@ npm run serve
109110
- Push to the branch: `git push origin feature-name`
110111
- Submit a pull request detailing your changes.
111112

113+
## Tech Stack
114+
115+
### Core
116+
117+
- **Framework & Libraries:** Docusaurus 3 (React + TypeScript)
118+
- **Language:** TypeScript (Node.js ≥ 18)
119+
- **Styling:** Tailwind CSS 4
120+
- **UI Components:** Radix UI, Framer Motion
121+
122+
### Developer Tools
123+
124+
- **Linting & Formatting:** ESLint, Prettier
125+
- **Type Checking:** TypeScript (`tsc`)
126+
112127
## Project Structure
113128

114129
```
@@ -158,7 +173,7 @@ recode-website/
158173

159174
## License
160175

161-
This project is licensed under the [MIT License](LICENSE).
176+
This project is open source and available under the [MIT License](LICENSE).
162177

163178
## Badges
164179

src/components/topmate/TopMateSection.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const TopMateSection = ({ setShowTopmate }) => {
77

88
const profileData = {
99
title: "1:1 Mentorship Call",
10-
description: "Book a slot, Free for Hive Community Members",
10+
description: "Book a slot, Free for recode hive Community Members",
1111
duration: "30 mins",
1212
profileImage: "/sanjay.png",
1313
username: "sanjaykv",

src/pages/community/index.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,12 @@ export default function CommunityPage(): React.ReactElement {
191191

192192
return (
193193
<Layout
194-
title="Hive Community"
194+
title="recode hive Community"
195195
description="Welcome to recode hive — a community built for everyone to learn, share, and grow."
196196
>
197197
<div className="community-page">
198198
<Head>
199-
<meta property="og:title" content="Hive Community - recode hive" />
199+
<meta property="og:title" content="recode hive Community - recode hive" />
200200
<meta property="og:description" content="Join our thriving community of developers, designers, and creators." />
201201
</Head>
202202

@@ -217,7 +217,7 @@ export default function CommunityPage(): React.ReactElement {
217217
>
218218
<div className="hero-icon">🐝</div>
219219
<h1 className="community-hero-title">
220-
Welcome to Hive Community
220+
Welcome to recode hive Community
221221
</h1>
222222
<p className="community-hero-description">
223223
Welcome to <strong>recode hive</strong> — a community built for everyone to{' '}

src/pages/showcase/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ function ShowcaseHeader() {
155155
rel="noreferrer"
156156
>
157157
<Translate id="showcase.header.button">
158-
🌟 Join the Hive Community
158+
🌟 Join the recode hive Community
159159
</Translate>
160160
</a>
161161
</motion.div>
@@ -352,7 +352,7 @@ function ShowcaseCards() {
352352
}}
353353
>
354354
<Translate id="showcase.favoritesList.title">
355-
Best of the Hive
355+
Best of the hive
356356
</Translate>
357357
</motion.h2>
358358
<motion.h2

0 commit comments

Comments
 (0)