Skip to content

Commit 40d8203

Browse files
justin808justin808
committed
getting-started.md - justin manual done
1 parent 5c09a4c commit 40d8203

File tree

2 files changed

+174
-1
lines changed

2 files changed

+174
-1
lines changed

‎docs/README.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# React on Rails Documentation
2+
3+
> **Integrate React components seamlessly into your Rails application with server-side rendering, hot reloading, and more.**
4+
5+
## 🚀 Quick Start
6+
7+
New to React on Rails? Start here for the fastest path to success:
8+
9+
**→ [15-Minute Quick Start Guide](./quick-start/README.md)**
10+
11+
Already have Rails + Shakapacker? **→ [Add React on Rails in 5 minutes](./quick-start/existing-app.md)**
12+
13+
## 📚 Learning Paths
14+
15+
Choose your journey based on your experience level:
16+
17+
### 🔰 **Beginner Path**
18+
19+
Perfect if you're new to React on Rails
20+
21+
1. **[Quick Start](./quick-start/README.md)** - Get your first component running
22+
2. **[Core Concepts](./getting-started.md)** - Understand the basics
23+
3. **[Tutorial](./guides/tutorial.md)** - Build something useful
24+
25+
### ⚡ **Experienced Developer Path**
26+
27+
Jump to what you need
28+
29+
- **[Installation Guide](./guides/installation.md)** - Detailed setup
30+
- **[API Reference](./api/README.md)** - Quick lookup
31+
- **[Advanced Features](./guides/advanced/README.md)** - SSR, Redux, Router
32+
33+
### 🏗️ **Migrating from Other Solutions**
34+
35+
- **[From react-rails](./guides/migration/from-react-rails.md)**
36+
- **[From Webpacker](./guides/migration/from-webpacker.md)**
37+
- **[From custom setup](./guides/migration/from-custom.md)**
38+
39+
## 🎯 Popular Use Cases
40+
41+
Find guidance for your specific scenario:
42+
43+
| I want to... | Go here |
44+
| ----------------------------------- | ------------------------------------------------------- |
45+
| **Add React to existing Rails app** | [Installation Guide](./guides/installation.md) |
46+
| **Enable server-side rendering** | [SSR Guide](./guides/fundamentals/server-rendering.md) |
47+
| **Set up hot reloading** | [HMR Setup](./guides/development/hot-reloading.md) |
48+
| **Use Redux with Rails** | [Redux Integration](./guides/state-management/redux.md) |
49+
| **Deploy to production** | [Deployment Guide](./guides/deployment/README.md) |
50+
| **Troubleshoot issues** | [Troubleshooting](./troubleshooting/README.md) |
51+
52+
## 📖 Complete Documentation
53+
54+
### Core Guides
55+
56+
- **[Getting Started](./getting-started.md)** - Installation and basic setup
57+
- **[Tutorial](./guides/tutorial.md)** - Complete walkthrough with examples
58+
- **[Configuration](./guides/configuration.md)** - All configuration options
59+
- **[View Helpers](./api/view-helpers-api.md)** - Using `react_component` method
60+
61+
### Features
62+
63+
- **[Server-Side Rendering](./guides/fundamentals/server-rendering.md)** - SSR setup and optimization
64+
- **[Auto-Bundling](./guides/auto-bundling-file-system-based-automated-bundle-generation.md)** - Automatic bundle generation
65+
- **[Redux Integration](./guides/state-management/redux.md)** - State management with Redux
66+
- **[React Router](./guides/routing/react-router.md)** - Client-side routing
67+
- **[Internationalization](./guides/i18n.md)** - I18n support
68+
69+
### Development
70+
71+
- **[Hot Module Replacement](./guides/development/hot-reloading.md)** - Fast development workflow
72+
- **[Testing](./guides/development/testing.md)** - Testing React components
73+
- **[Debugging](./guides/development/debugging.md)** - Common debugging techniques
74+
75+
### Deployment & Performance
76+
77+
- **[Deployment](./guides/deployment/README.md)** - Production deployment guide
78+
- **[Performance](./guides/performance/README.md)** - Optimization techniques
79+
- **[Bundle Optimization](./guides/performance/webpack-bundle-optimization.md)** - Reduce bundle size
80+
81+
## 🆘 Need Help?
82+
83+
### Quick Solutions
84+
85+
- **[Troubleshooting Guide](./troubleshooting/README.md)** - Common issues and solutions
86+
- **[FAQ](./troubleshooting/faq.md)** - Frequently asked questions
87+
- **[Error Messages](./troubleshooting/error-messages.md)** - Decode error messages
88+
89+
### Community Support
90+
91+
- **[React + Rails Slack](https://reactrails.slack.com)** - Real-time community help
92+
- **[GitHub Discussions](https://github.com/shakacode/react_on_rails/discussions)** - Ask questions
93+
- **[GitHub Issues](https://github.com/shakacode/react_on_rails/issues)** - Report bugs
94+
95+
### Professional Support
96+
97+
- **[ShakaCode Support](mailto:[email protected])** - Professional React on Rails help
98+
- **[React on Rails Pro](https://www.shakacode.com/react-on-rails-pro/)** - Advanced features and support
99+
100+
## 🔗 External Resources
101+
102+
- **[Shakapacker Documentation](https://github.com/shakacode/shakapacker)** - Webpack integration for Rails
103+
- **[React Documentation](https://react.dev)** - Official React docs
104+
- **[Rails Guides](https://guides.rubyonrails.org)** - Ruby on Rails documentation
105+
106+
---
107+
108+
## 📚 Table of Contents
109+
110+
### API Reference
111+
112+
- [View Helpers API](./api/view-helpers-api.md)
113+
- [Redux Store API](./api/redux-store-api.md)
114+
- [Configuration API](./api/configuration-api.md)
115+
116+
### Guides
117+
118+
#### Getting Started
119+
120+
- [Installation](./getting-started.md)
121+
- [Tutorial](./guides/tutorial.md)
122+
- [Basic Configuration](./guides/configuration.md)
123+
124+
#### Core Features
125+
126+
- [Server-Side Rendering](./guides/fundamentals/server-rendering.md)
127+
- [Component Registration](./guides/fundamentals/component-registration.md)
128+
- [Props and RailsContext](./guides/render-functions-and-railscontext.md)
129+
130+
#### State Management
131+
132+
- [Redux Integration](./guides/state-management/redux.md)
133+
- [Context API](./guides/state-management/context-api.md)
134+
135+
#### Routing
136+
137+
- [React Router Setup](./guides/routing/react-router.md)
138+
- [Server-Side Routing](./guides/routing/server-side-routing.md)
139+
140+
#### Advanced Topics
141+
142+
- [Webpack Configuration](./guides/webpack-configuration.md)
143+
- [Code Splitting](./javascript/code-splitting.md)
144+
- [Performance Optimization](./guides/performance/README.md)
145+
146+
#### Development
147+
148+
- [Hot Module Replacement](./guides/development/hot-reloading.md)
149+
- [Testing Components](./guides/development/testing.md)
150+
- [Debugging](./guides/development/debugging.md)
151+
152+
#### Deployment
153+
154+
- [Production Setup](./guides/deployment/README.md)
155+
- [Heroku Deployment](./guides/deployment/heroku-deployment.md)
156+
- [Docker Setup](./guides/deployment/docker.md)
157+
158+
### Migration Guides
159+
160+
- [Upgrading React on Rails](./guides/upgrading-react-on-rails.md)
161+
- [From Webpacker to Shakapacker](./guides/migration/webpacker-to-shakapacker.md)
162+
- [From react-rails](./guides/migration/from-react-rails.md)
163+
164+
### Troubleshooting
165+
166+
- [Common Issues](./troubleshooting/README.md)
167+
- [Error Messages](./troubleshooting/error-messages.md)
168+
- [Performance Issues](./troubleshooting/performance.md)
169+
170+
### Contributing
171+
172+
- [Contributing Guide](../CONTRIBUTING.md)
173+
- [Development Setup](./contributor-info/development.md)
174+
- [Pull Request Guidelines](./contributor-info/pull-requests.md)

‎docs/guides/auto-bundling-file-system-based-automated-bundle-generation.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,6 @@ As of version 13.3.4, bundles inside directories that match `config.components_s
602602
- **Minification**: Some code might break during minification - check console for errors
603603
- **Environment**: Use `bin/dev prod` to test production-like assets locally
604604

605-
606605
### Debug Mode
607606

608607
To debug auto-loading behavior, temporarily add logging to see what bundles are being loaded:

0 commit comments

Comments
 (0)