diff --git a/README.md b/README.md index 5a4ecd8d..2f713fa0 100644 --- a/README.md +++ b/README.md @@ -3,118 +3,95 @@ recode hive logo +

recode hive

- - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) -Stars Badge -Forks Badge -Pull Requests Badge -Issues Badge -GitHub contributors -License Badge -[![](https://visitcount.itsvg.in/api?id=Opensource-practice&label=Profile%20Views&color=0&icon=5&pretty=true)](https://visitcount.itsvg.in) - -This is your all-in-one resource for documentation and guidance on how to contribute. -
---- +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors) +[![Stars Badge](https://img.shields.io/github/stars/recodehive/recode-website)](https://github.com/recodehive/recode-website/stargazers) +[![Forks Badge](https://img.shields.io/github/forks/recodehive/recode-website)](https://github.com/recodehive/recode-website/network/members) +[![Pull Requests Badge](https://img.shields.io/github/issues-pr/recodehive/recode-website)](https://github.com/recodehive/recode-website/pulls) +[![Issues Badge](https://img.shields.io/github/issues/recodehive/recode-website)](https://github.com/recodehive/recode-website/issues) +[![Contributors](https://img.shields.io/github/contributors/recodehive/recode-website?color=2b9348)](https://github.com/recodehive/recode-website/graphs/contributors) +[![License Badge](https://img.shields.io/github/license/recodehive/recode-website?color=2b9348)](https://github.com/recodehive/recode-website/LICENSE) -Have questions or need guidance? Our contributors are happy to help! Join the conversation and get your doubts resolved: +**Your all-in-one resource for learning Git, GitHub, Python, and Next.js through comprehensive tutorials and hands-on projects.** -[![](https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logo=Discord&logoColor=white)](https://discord.gg/Yxv9RA3r) [![Follow Us On LinkedIn](https://img.shields.io/badge/Follow%20on-LinkedIn-blue?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/sanjay-k-v/) +[Website](https://recodehive.com/) β€’ [Documentation](https://recodehive.com/docs) β€’ [Contributing](community/contributing-guidelines.md) β€’ [Discord](https://discord.gg/Yxv9RA3r) -## Getting Started + -To get started with contributing to recode hive, please refer to our [Contributing Guidelines](community/contributing-guidelines.md). +--- -
- -

How to Contribute to this Repo | How to Setup - Watch Video

- - - - -
+## πŸ“– About -### Follow these steps: +recode hive is an open-source educational platform built to help developers master essential technologies through interactive tutorials, practical guides, and community-driven learning. Whether you're a beginner taking your first steps in programming or an advanced developer looking to sharpen your skills, recode hive provides the resources you need. -```mermaid -flowchart LR - Fork[Fork the project]-->branch[Create a New Branch] - branch-->Edit[Edit file] - Edit-->commit[Commit the changes] - commit -->|Finally|creatpr((Create a Pull Request)) -``` +## ✨ Features -1. **Clone the repository:** +- **Comprehensive Tutorials** – Step-by-step guides for Git, GitHub, Python, and Next.js, suitable for beginners and advanced users +- **Hands-On Setup Guides** – Practical walkthroughs for setting up projects, repositories, and development environments +- **Leaderboards & Challenges** – Track your progress, earn points, and compete with others to stay motivated +- **Documentation Hub** – Centralized docs for quick reference, best practices, and deep dives into concepts +- **Merchandise Store** – Exclusive branded merchandise to celebrate your learning milestones +- **User Dashboard** – Personalized space to monitor your completed tutorials, achievements, and activity +- **Community & Collaboration** – Engage with other learners, share tips, and collaborate on projects - ```bash - git clone https://github.com/your-username/recodehive-website.git - ``` +## πŸš€ Quick Start -2. **Navigate to the project directory:** +### Prerequisites - ```bash - cd recode-website - ``` +- [Node.js](https://nodejs.org/) β‰₯ 18 +- [Docker](https://docs.docker.com/engine/install/) (optional, for containerized development) +- Docker Compose (optional) -3. **Prerequisites** +### Installation -- [Docker](https://docs.docker.com/engine/install/) installed -- Docker compose installed (Optional) +**Clone the repository:** -4. **Build the Docker Image:** - Only do this if you are setting up this project locally for the first time. (only build) +```bash +git clone https://github.com/your-username/recode-website.git +cd recode-website +``` - ```bash - docker build -t recodehive-app . - ``` +**Using Docker (Recommended):** -5. **Run the Container:** +```bash +# Build the image (first time only) +docker build -t recodehive-app . - ```bash - docker run -p 3000:3000 recodehive-app - ``` +# Run the container +docker run -p 3000:3000 recodehive-app +``` - This command will start a development server and open the application in your default web browser. +**Using Docker Compose (with hot-reload):** -## Local Development with Docker Compose & Hot Reload +```bash +docker-compose up +``` -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. +Your application will be available at http://localhost:3000 -### Quick Start +**Traditional Setup:** ```bash -git clone https://github.com/your-username/recode-website.git -cd recodehive-website -docker-compose up +npm install +npm run start ``` -### Production Deployment +### Production Build ```bash npm run build npm run serve ``` -**If you'd like to contribute to recode hive, please follow these guidelines:** +## πŸ› οΈ Tech Stack -- **Fork** the repository and clone it locally. -- Create a new branch for your feature or bug fix: `git checkout -b feature-name` -- Make your changes and test thoroughly. -- Commit your changes: `git commit -m "Brief description of your changes"` -- Push to the branch: `git push origin feature-name` -- Submit a pull request detailing your changes. +### Core Technologies -## Tech Stack - -### Core - -- **Framework & Libraries:** Docusaurus 3 (React + TypeScript) +- **Framework:** Docusaurus 3 (React + TypeScript) - **Language:** TypeScript (Node.js β‰₯ 18) - **Styling:** Tailwind CSS 4 - **UI Components:** Radix UI, Framer Motion @@ -124,46 +101,53 @@ npm run serve - **Linting & Formatting:** ESLint, Prettier - **Type Checking:** TypeScript (`tsc`) -## Project Structure +## πŸ“ Project Structure ``` recode-website/ -| -β”œβ”€β”€ .github/ πŸ”Ή GitHub meta files -| β”œβ”€β”€ ISSUE_TEMPLATE/ -| β”œβ”€β”€ workflows/ -| └── pull_request_template.md -β”œβ”€β”€ blog/ πŸ”ΉProject Blog -| β”œβ”€β”€ git-coding-agent/ -| β”œβ”€β”€ google-backlinks/ -| β”œβ”€β”€... -β”œβ”€β”€ community/ πŸ”Ή Contributor Docs -| β”œβ”€β”€ contributing-guidelines.md -| β”œβ”€β”€ index.md -| β”œβ”€β”€ our-documentation.md -| └── understand-lint-checks.md -β”œβ”€β”€ docs/ πŸ”ΉDocumentation -| β”œβ”€β”€ GitHub/ -| β”œβ”€β”€ Google-Student-Ambassador/ -| β”œβ”€β”€ ... -β”œβ”€β”€ src/ πŸ”ΉSource Code -| └── components/ -| β”œβ”€β”€ css/ -| └── custom.css -| β”œβ”€β”€ data/ -| β”œβ”€β”€ database/ -| β”œβ”€β”€ lib/ -| β”œβ”€β”€ pages/ -| β”œβ”€β”€ plugins/ -| β”œβ”€β”€ services/ -| β”œβ”€β”€ style/ -| └── globals.css -| β”œβ”€β”€ theme/ -| └── utils/ -β”œβ”€β”€ static/ πŸ”Ή Public Assets -| β”œβ”€β”€ icons, img -| β”œβ”€β”€ .nojekyll -| └── *.png +β”‚ +β”œβ”€β”€ .github/ # GitHub configuration +β”‚ β”œβ”€β”€ ISSUE_TEMPLATE/ +β”‚ β”œβ”€β”€ workflows/ +β”‚ └── pull_request_template.md +β”‚ +β”œβ”€β”€ blog/ # Blog posts +β”‚ β”œβ”€β”€ git-coding-agent/ +β”‚ β”œβ”€β”€ google-backlinks/ +β”‚ └── ... +β”‚ +β”œβ”€β”€ community/ # Community documentation +β”‚ β”œβ”€β”€ contributing-guidelines.md +β”‚ β”œβ”€β”€ index.md +β”‚ β”œβ”€β”€ our-documentation.md +β”‚ └── understand-lint-checks.md +β”‚ +β”œβ”€β”€ docs/ # Main documentation +β”‚ β”œβ”€β”€ GitHub/ +β”‚ β”œβ”€β”€ Google-Student-Ambassador/ +β”‚ └── ... +β”‚ +β”œβ”€β”€ src/ # Source code +β”‚ β”œβ”€β”€ components/ # React components +β”‚ β”œβ”€β”€ css/ +β”‚ β”‚ └── custom.css +β”‚ β”œβ”€β”€ data/ +β”‚ β”œβ”€β”€ database/ +β”‚ β”œβ”€β”€ lib/ +β”‚ β”œβ”€β”€ pages/ +β”‚ β”œβ”€β”€ plugins/ +β”‚ β”œβ”€β”€ services/ +β”‚ β”œβ”€β”€ style/ +β”‚ β”‚ └── globals.css +β”‚ β”œβ”€β”€ theme/ +β”‚ └── utils/ +β”‚ +β”œβ”€β”€ static/ # Static assets +β”‚ β”œβ”€β”€ icons/ +β”‚ β”œβ”€β”€ img/ +β”‚ β”œβ”€β”€ .nojekyll +β”‚ └── *.png +β”‚ β”œβ”€β”€ .gitignore β”œβ”€β”€ CODE_OF_CONDUCT.md β”œβ”€β”€ LICENSE @@ -171,54 +155,128 @@ recode-website/ └── ... ``` -## License +## 🀝 Contributing + +We welcome contributions from developers of all skill levels! Here's how you can get started: + +### Contribution Workflow + +```mermaid +flowchart LR + Fork[Fork the project]-->branch[Create a New Branch] + branch-->Edit[Edit file] + Edit-->commit[Commit the changes] + commit -->|Finally|creatpr((Create a Pull Request)) +``` + +### Step-by-Step Guide + +**Fork the repository** on GitHub + +**Clone your fork:** + +```bash +git clone https://github.com/your-username/recode-website.git +cd recode-website +``` + +**Create a new branch:** + +```bash +git checkout -b feature/your-feature-name +``` + +**Make your changes** and test thoroughly + +**Commit your changes:** -This project is open source and available under the [MIT License](LICENSE). +```bash +git commit -m "Add: brief description of your changes" +``` -## Badges +**Push to your fork:** + +```bash +git push origin feature/your-feature-name +``` + +**Submit a Pull Request** with a detailed description of your changes + +### Video Tutorial + +
+ +

How to Contribute to this Repo | How to Setup - Watch Video

+ + + + +
+ +For detailed guidelines, please refer to our [Contributing Guidelines](community/contributing-guidelines.md). + +## πŸ“š Documentation + +- [Contributing Guidelines](community/contributing-guidelines.md) +- [Code of Conduct](CODE_OF_CONDUCT.md) +- [Understanding Lint Checks](community/understand-lint-checks.md) +- [Our Documentation Standards](community/our-documentation.md) + +## πŸ’¬ Community + +Join our community and connect with fellow learners: + +[![Discord](https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logo=Discord&logoColor=white)](https://discord.gg/Yxv9RA3r) +[![LinkedIn](https://img.shields.io/badge/Follow%20on-LinkedIn-blue?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/sanjay-k-v/) + +## πŸ“Š Project Statistics ![GitHub commit activity (yearly)](https://img.shields.io/github/commit-activity/y/RecodeHive/recode-website) ![GitHub commit activity (monthly)](https://img.shields.io/github/commit-activity/m/RecodeHive/recode-website) -![GitHub commit activity (weekly)](https://img.shields.io/github/commit-activity/w/RecodeHive/recode-website) -![GitHub commit activity (daily)](https://img.shields.io/github/commit-activity/t/RecodeHive/recode-website) -![GitHub Org's stars](https://img.shields.io/github/stars/RecodeHive/recode-website) -![GitHub License](https://img.shields.io/github/license/RecodeHive/recode-website) +![GitHub stars](https://img.shields.io/github/stars/RecodeHive/recode-website) ![GitHub forks](https://img.shields.io/github/forks/RecodeHive/recode-website) -![GitHub watchers](https://img.shields.io/github/watchers/RecodeHive/recode-website) -![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/RecodeHive/recode-website) -![GitHub repo size](https://img.shields.io/github/repo-size/RecodeHive/recode-website) -![GitHub file/directory count](https://img.shields.io/github/directory-file-count/RecodeHive/recode-website) ![GitHub open issues](https://img.shields.io/github/issues/RecodeHive/recode-website) -![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/RecodeHive/recode-website) ![GitHub open PRs](https://img.shields.io/github/issues-pr/RecodeHive/recode-website) -![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/RecodeHive/recode-website) +![GitHub repo size](https://img.shields.io/github/repo-size/RecodeHive/recode-website) ![Last commit](https://img.shields.io/github/last-commit/RecodeHive/recode-website) -## Contributors +## πŸ‘₯ Contributors + +We appreciate all contributions to recode hive! Thank you to everyone who has helped make this project better. +## βš–οΈ License + +This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details. + +## πŸ“¬ Stay Connected + +Stay up to date with the latest from recode hive: + +- **Website:** [recodehive.com](https://recodehive.com/) +- **Instagram:** [@nomad_brains](https://www.instagram.com/nomad_brains/) +- **LinkedIn:** [Sanjay K V](https://www.linkedin.com/in/sanjay-k-v/) +- **Twitter:** [@sanjay*kv*](https://x.com/sanjay_kv_) +- **YouTube:** [@RecodeHive](https://www.youtube.com/@RecodeHive) +- **Newsletter:** [Subscribe](https://recodehive.substack.com/) + +--- +
-Happy open-source contributionsβ€”here’s to your career success! πŸŽ‰ +**Happy open-source contributionsβ€”here's to your career success! πŸŽ‰**

-### recode hive - -[Website](https://recodehive.com/) | [Instagram](https://www.instagram.com/nomad_brains/) | [LinkedIn](https://www.linkedin.com/in/sanjay-k-v/) | [Twitter](https://x.com/sanjay_kv_) | [YouTube](https://www.youtube.com/@RecodeHive)
- -**πŸ”” Don’t miss a beat!**
-Subscribe to receive our newsletter directly in your inbox for the latest career insights & tailored to your journey.
- -[![Subscribe to Our Newsletter](https://img.shields.io/badge/Subscribe%20to%20Our%20Newsletter-%F0%9F%93%A9-blue)](https://recodehive.substack.com/)
+Made with ❀️ by the recode hive community - + Back to Top
diff --git a/community/contributing-guidelines.md b/community/contributing-guidelines.md index 57c69e39..cd89723b 100644 --- a/community/contributing-guidelines.md +++ b/community/contributing-guidelines.md @@ -5,21 +5,18 @@ sidebar_label: Contributing Guidelines sidebar_position: 2 --- -Thank you for considering contributing to recode hive! We welcome contributions from everyone. Whether you're a seasoned developer or just starting out, there are many ways to get involved and help improve recode hive. This document outlines the guidelines for contributing to this project. +## Table of Contents -## Getting Started +- [Local Setup Guide](#local-setup-guide) +- [Environment Setup (for GitHub API access)](#environment-setup-for-github-api-access) +- [Contributing to recode hive](#contributing-to-recode-hive) +- [Formatting](#formatting) +- [Branding & Naming Conventions](#branding--naming-conventions) +- [License](#license) -To get started with contributing to recode hive, please refer to our [Contributing Guidelines](/community/contributing-guidelines). +## Local Setup Guide -Follow these steps: - -```mermaid -flowchart LR - Fork[Fork the project]-->branch[Create a New Branch] - branch-->Edit[Edit file] - Edit-->commit[Commit the changes] - commit -->|Finally|creatpr((Create a Pull Request)) -``` +### How to set up recode hive: 1. **Clone the repository:** @@ -49,26 +46,138 @@ flowchart LR This command will start a development server and open the application in your default web browser. -**If you'd like to contribute to recode hive, please follow these guidelines:** +## Environment Setup (for GitHub API access) -- **Fork** the repository and clone it locally. -- Create a new branch for your feature or bug fix: `git checkout -b feature-name` -- Make your changes and test thoroughly. -- Commit your changes: `git commit -m "Brief description of your changes"` -- Push to the branch: `git push origin feature-name` -- Submit a pull request detailing your changes. +Some parts of the dashboard β€” such as the Leaderboard β€” require access to the GitHub API. +To avoid rate-limit issues, you’ll need to set up a GitHub Personal Access Token (PAT) locally. -### Branding & Naming Conventions +1. **Copy the example environment file** -- Use **`recode hive`** in lowercase for all mentions of the project name. -- Update any headers, titles, or utility constants accordingly. + ```bash + cp .env.example .env + ``` + + This creates your local `.env` configuration file. + +2. **Generate a GitHub Personal Access Token** + 1. Go to [https://github.com/settings/tokens](https://github.com/settings/tokens) + 2. Click **β€œGenerate new token (classic)”** + 3. Give it a name (e.g. `recode hive`) + 4. Select **no special permissions** (the default is fine for public data) + 5. Copy the generated token + +3. **Add your token to `.env`** + + Open `.env` and update this line: + + ```bash + GITHUB_TOKEN=ghp_your_generated_token_here + ``` + +## Contributing to recode hive + +We welcome contributions! Follow these steps to get started. + +1. **Fork the Repository** + - Go to the [recode hive repository](https://github.com/recodehive/recode-website) and click **Fork**. + +2. **Clone Your Fork Locally** + + ```bash + git clone https://github.com/your-username/recodehive-website.git + cd recodehive-website + ``` + +3. **Add the Original Repository as Upstream** + + This allows you to fetch changes from the main repository to keep your fork up to date. + + ```bash + git remote add upstream + ``` + + Verify the remotes: + + ```bash + git remote -v + ``` + + You should see both origin (your fork) and upstream (main repository). + +4. **Keep Your Fork Updated** + + Before starting a new feature or bug fix, update your local main branch: + + ```bash + git checkout main + git fetch upstream + git merge upstream/main + ``` -### Formatting + This ensures your branch starts from the latest version of the main repository. -- Follow the existing code style for spacing, indentation, and Markdown formatting. -- Use Prettier or ESLint to auto-format files before committing. +5. **Create a New Branch** + + Create a branch for your feature or bug fix: + + ```bash + git checkout -b feature-name + ``` + +6. **Commit Your Changes** + + ```bash + git add . + git commit -m "Brief description of your changes" + ``` + +7. **Push Your Branch to Your Fork** + + ```bash + git push origin feature-name + ``` + +8. **Open a Pull Request** + 1. Go to your fork on GitHub. + + 2. Click Compare & pull request for your branch. + + 3. Fill out the PR template with a clear description of your changes. + + 4. Submit the PR. + + > Tip: If your branch falls behind main, you can fetch and merge updates from upstream again before pushing. + +## Formatting + +To ensure consistent code style and catch errors before committing, please follow these steps: + +2. **Automatically fix linting issues where possible**: + + ```bash + npm run lint:fix + ``` + +3. **Format code according to project conventions**: + + ```bash + npm run format + ``` + +4. **Build the project to verify everything compiles correctly**: + + ```bash + npm run build + ``` + + It’s recommended to run these commands before committing to maintain code quality and consistency. + +## Branding & Naming Conventions + +- Use **`recode hive`** in lowercase for all mentions of the project name. +- Update any headers, titles, or utility constants accordingly. -## Exceptions to Lowercase Branding +### Exceptions to Lowercase Branding While we use lowercase **`recode hive`** throughout the project for consistency, there are some places where the exact repository name with capitalization must be used: @@ -78,4 +187,4 @@ While we use lowercase **`recode hive`** throughout the project for consistency, ## License -This project is licensed under the [MIT License](/License). +This project is open source and available under the [MIT License](LICENSE). diff --git a/community/understand-lint-checks.md b/community/understand-lint-checks.md index cfff4e28..5480af35 100644 --- a/community/understand-lint-checks.md +++ b/community/understand-lint-checks.md @@ -70,11 +70,6 @@ npm run build ## 🧹 Code Quality Checks -Standard Tool(s) -Linting eslint -Formatting prettier -Type Checking tsc - | Standard | Tools(s) | | --------------- | -------- | | `Linting` | eslint |