Skip to content
Draft
Changes from all commits
Commits
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
234 changes: 233 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,234 @@
# Contributor
This is the contributor repository

Welcome to the **Contributor** repository! This repository serves as a guide and central hub for contributors who want to replicate the [Recode Website](https://github.com/recodehive/recode-website) project and contribute to the Recode community.

## πŸš€ About Recode Website

The Recode Website is a comprehensive documentation platform built with **Docusaurus v3** that provides:
- πŸ“š Technical documentation and tutorials
- πŸ“ Community blog posts and insights
- 🀝 Contributor guidelines and resources
- 🎯 Open-source project showcases

## πŸ“‹ Prerequisites

Before you begin, ensure you have the following installed:

- **Node.js** (version 18.0 or higher) - [Download here](https://nodejs.org/)
- **npm** or **yarn** package manager
- **Git** - [Installation guide](https://git-scm.com/downloads)
- **Docker** (optional) - [Installation guide](https://docs.docker.com/engine/install/)

## πŸ”§ How to Replicate the Recode Website Project

### Method 1: Standard Setup (Recommended)

1. **Fork and Clone the Repository**
```bash
# Fork the repository first on GitHub, then clone your fork
git clone https://github.com/your-username/recode-website.git
cd recode-website
```

2. **Install Dependencies**
```bash
npm install
# or
yarn install
```

3. **Set Up Environment Variables (Optional)**
```bash
# Copy the example environment file
cp .env.example .env

# Edit .env with your preferred editor and add your configuration
# This is optional but recommended for full functionality
```

4. **Start the Development Server**
```bash
npm start
# or
yarn start
```

5. **Open Your Browser**
Navigate to `http://localhost:3000` to see the website running locally.

### Method 2: Docker Setup

1. **Clone the Repository**
```bash
git clone https://github.com/recodehive/recode-website.git
cd recode-website
```

2. **Build the Docker Image**
```bash
docker build -t recodehive-app .
```

3. **Run the Container**
```bash
docker run -p 3000:3000 recodehive-app
```

4. **Access the Application**
Open `http://localhost:3000` in your browser.

### Method 3: Docker Compose (Alternative)

1. **Clone and Navigate**
```bash
git clone https://github.com/recodehive/recode-website.git
cd recode-website
```

2. **Run with Docker Compose**
```bash
docker-compose up
```

## 🀝 How to Contribute

We welcome contributions from developers of all skill levels! Here's how you can get involved:

### 🌟 Contribution Workflow

```mermaid
flowchart LR
Fork[Fork the Project] --> Clone[Clone Your Fork]
Clone --> Branch[Create Feature Branch]
Branch --> Code[Make Changes]
Code --> Test[Test Changes]
Test --> Commit[Commit Changes]
Commit --> Push[Push to Fork]
Push --> PR[Create Pull Request]
```

### πŸ“ Step-by-Step Guide

1. **Fork the Repository**
- Click the "Fork" button on the [recode-website repository](https://github.com/recodehive/recode-website)

2. **Clone Your Fork**
```bash
git clone https://github.com/your-username/recode-website.git
cd recode-website
```

3. **Create a New Branch**
```bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-fix-name
```

4. **Make Your Changes**
- Follow the existing code style and conventions
- Ensure your changes are well-documented
- Test your changes thoroughly

5. **Commit Your Changes**
```bash
git add .
git commit -m "feat: add your descriptive commit message"
```

6. **Push to Your Fork**
```bash
git push origin feature/your-feature-name
```

7. **Create a Pull Request**
- Go to the original repository
- Click "New Pull Request"
- Provide a clear description of your changes

### 🎯 Types of Contributions

- **πŸ“– Documentation**: Improve existing docs or add new tutorials
- **πŸ› Bug Fixes**: Fix issues and improve functionality
- **✨ Features**: Add new features or enhance existing ones
- **🎨 UI/UX**: Improve the user interface and experience
- **πŸ§ͺ Testing**: Add or improve test coverage
- **πŸ“ Content**: Write blog posts or community content

## πŸ“ Project Structure

```
recode-website/
β”œβ”€β”€ .github/ # GitHub workflows and templates
β”œβ”€β”€ blog/ # Blog posts and articles
β”œβ”€β”€ community/ # Community guidelines and docs
β”œβ”€β”€ docs/ # Main documentation
β”œβ”€β”€ src/ # Source code
β”‚ β”œβ”€β”€ components/ # React components
β”‚ β”œβ”€β”€ css/ # Custom CSS
β”‚ β”œβ”€β”€ pages/ # Custom pages
β”‚ └── ...
β”œβ”€β”€ static/ # Static assets (images, icons)
β”œβ”€β”€ docusaurus.config.ts # Docusaurus configuration
β”œβ”€β”€ package.json # Dependencies and scripts
└── README.md # Project documentation
```

## πŸ› οΈ Development Scripts

- `npm start` - Start development server
- `npm run build` - Build for production
- `npm run serve` - Serve production build locally
- `npm run clear` - Clear Docusaurus cache
- `npm run typecheck` - Run TypeScript checks

## πŸ“‹ Contributing Guidelines

### Code of Conduct
We follow a comprehensive [Code of Conduct](https://github.com/recodehive/recode-website/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming environment for all contributors.

### Pull Request Guidelines
- Keep PRs focused and atomic
- Include clear descriptions of changes
- Add tests when applicable
- Update documentation as needed
- Follow the existing code style

### Commit Message Convention
Use clear, descriptive commit messages:
- `feat:` for new features
- `fix:` for bug fixes
- `docs:` for documentation changes
- `style:` for formatting changes
- `refactor:` for code refactoring

## πŸ”— Useful Resources

- **πŸ“– [Full Contributing Guide](https://github.com/recodehive/recode-website/blob/main/community/contributing-guidelines.md)**
- **🌐 [Live Website](https://recodehive.com/)**
- **πŸ’¬ [Discord Community](https://discord.gg/Yxv9RA3r)**
- **πŸ“Ί [Setup Video Tutorial](https://www.loom.com/share/c8d8d5f0c2534a1f86fc510dcef52ee0)**

## 🀝 Community & Support

- **Discord**: [Join our Discord](https://discord.gg/Yxv9RA3r)
- **LinkedIn**: [Follow on LinkedIn](https://www.linkedin.com/in/sanjay-k-v/)
- **Newsletter**: [Subscribe to Newsletter](https://recodehive.substack.com/)

## πŸ“„ License

This project is licensed under the [MIT License](LICENSE).

## πŸ™ Acknowledgments

Thanks to all contributors who help make Recode a better platform for everyone!

---

<div align="center">

**πŸŽ‰ Happy Contributing! πŸŽ‰**

Ready to make your first contribution? [Start here!](https://github.com/recodehive/recode-website)

</div>