diff --git a/README.md b/README.md index 6777792..ddc78a4 100644 --- a/README.md +++ b/README.md @@ -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! + +--- + +
+ +**๐ŸŽ‰ Happy Contributing! ๐ŸŽ‰** + +Ready to make your first contribution? [Start here!](https://github.com/recodehive/recode-website) + +