Documentation

Everything you need to use, contribute to, and extend RigCrafter

GitHub Repository

View source code and contribute

Contribution Guide

Step-by-step guide to contributing

Issue Tracker

Report bugs and request features

Component Database

Understand the component data structure

Getting Started

Quick start guide and basic concepts

Installation & Setup Your First Build Understanding Components Basic Navigation

Core Features

Main features of RigCrafter

Component Selector Smart Recommendations Live Price Optimization

Run Locally

Steps to clone, install, and run the project on your machine

Clone the Repository Install Dependencies Run Development Server Open in Browser

User Guide

Master RigCrafter's features

Build Configuration Compatibility Checker Performance Estimates Export & Sharing Troubleshooting Best Practices

Project Structure

Understanding the codebase

Frontend Architecture Component System Data Management Build System

Firebase Integration

How to set up Firebase for authentication and Firestore

Firebase Project Setup Enable Authentication Enable Firestore .env.local Configuration Data Structure Manual Testing

Common Errors & Fixes

Resolve frequent issues faced during setup and usage

npm install --legacy-peer-deps Firebase Permission Denied Error Module Not Found Error React Version Conflict with Dependencies ESLint Plugin Import Errors

Contributing

Help us improve RigCrafter

Fork the Repository Development Setup Making Changes Pull Request Process Code Style Guide Component Data Updates Testing Guidelines Documentation Updates

Deployment Guide

Steps to deploy RigCrafter to production

Build the Project Set Environment Variables Choose a Hosting Platform Deploy to Vercel Deploy to Netlify Post Deployment Checks

Ready to Contribute?

RigCrafter is open source and community-driven. Whether you're fixing bugs, adding features, or improving documentation, your contributions make a difference.

View on GitHub Full Contributing Guide