Skip to content

Commit 3df4b6f

Browse files
committed
git commit -m "docs: add Tech Stack section to README"
Reformatted README for cleaner look Temporarily removed heading icons (may reintroduce later for visual consistency) Minor alignment and spacing adjustments
1 parent 76f8880 commit 3df4b6f

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
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

0 commit comments

Comments
 (0)