Skip to content

docs: add Tech Stack and reformat README, update naming consistency (Hive → recode hive) #810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 5, 2025
Merged

docs: add Tech Stack and reformat README, update naming consistency (Hive → recode hive) #810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3df4b6f
git commit -m "docs: add Tech Stack section to README"
sheikhlimon Oct 5, 2025
b05c142
docs: recode hive naming consistency
sheikhlimon Oct 5, 2025
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
25 changes: 20 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ To get started with contributing to recode hive, please refer to our [Contributi
<img style="max-width:700px;" src="https://cdn.loom.com/sessions/thumbnails/c8d8d5f0c2534a1f86fc510dcef52ee0-30cac2eeec09a266-full-play.gif">
</a>
</div>
Follow these steps:

### Follow these steps:

```mermaid
flowchart LR
Expand Down Expand Up @@ -80,20 +81,20 @@ flowchart LR

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

## ⚡ Local Development with Docker Compose & Hot Reload
## Local Development with Docker Compose & Hot Reload

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

### 🏃 Quick Start
### Quick Start

```bash
git clone https://github.com/your-username/recode-website.git
cd recodehive-website
docker-compose up
```

### 🚢 Production Deployment
### Production Deployment

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

## Tech Stack

### Core

- **Framework & Libraries:** Docusaurus 3 (React + TypeScript)
- **Language:** TypeScript (Node.js ≥ 18)
- **Styling:** Tailwind CSS 4
- **UI Components:** Radix UI, Framer Motion

### Developer Tools

- **Linting & Formatting:** ESLint, Prettier
- **Type Checking:** TypeScript (`tsc`)

## Project Structure

```
Expand Down Expand Up @@ -158,7 +173,7 @@ recode-website/

## License

This project is licensed under the [MIT License](LICENSE).
This project is open source and available under the [MIT License](LICENSE).

## Badges

Expand Down
2 changes: 1 addition & 1 deletion src/components/topmate/TopMateSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const TopMateSection = ({ setShowTopmate }) => {

const profileData = {
title: "1:1 Mentorship Call",
description: "Book a slot, Free for Hive Community Members",
description: "Book a slot, Free for recode hive Community Members",
duration: "30 mins",
profileImage: "/sanjay.png",
username: "sanjaykv",
Expand Down
6 changes: 3 additions & 3 deletions src/pages/community/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,12 +191,12 @@ export default function CommunityPage(): React.ReactElement {

return (
<Layout
title="Hive Community"
title="recode hive Community"
description="Welcome to recode hive — a community built for everyone to learn, share, and grow."
>
<div className="community-page">
<Head>
<meta property="og:title" content="Hive Community - recode hive" />
<meta property="og:title" content="recode hive Community - recode hive" />
<meta property="og:description" content="Join our thriving community of developers, designers, and creators." />
</Head>

Expand All @@ -217,7 +217,7 @@ export default function CommunityPage(): React.ReactElement {
>
<div className="hero-icon">🐝</div>
<h1 className="community-hero-title">
Welcome to Hive Community
Welcome to recode hive Community
</h1>
<p className="community-hero-description">
Welcome to <strong>recode hive</strong> — a community built for everyone to{' '}
Expand Down
4 changes: 2 additions & 2 deletions src/pages/showcase/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ function ShowcaseHeader() {
rel="noreferrer"
>
<Translate id="showcase.header.button">
🌟 Join the Hive Community
🌟 Join the recode hive Community
</Translate>
</a>
</motion.div>
Expand Down Expand Up @@ -352,7 +352,7 @@ function ShowcaseCards() {
}}
>
<Translate id="showcase.favoritesList.title">
Best of the Hive
Best of the hive
</Translate>
</motion.h2>
<motion.h2
Expand Down
Loading