Skip to content

Commit eef74f6

Browse files
chaomingchaoming
committed
docs: restructure FAQ into individual pages
1 parent 32ed9b6 commit eef74f6

File tree

11 files changed

+212
-0
lines changed

11 files changed

+212
-0
lines changed

‎content/faq/_index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "FAQ"
3+
linkTitle: "FAQ"
4+
weight: 4
5+
description: >
6+
Frequently asked questions about fireact.dev
7+
---

‎content/faq/applications.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "What kind of applications can I build?"
3+
linkTitle: "Applications"
4+
weight: 8
5+
description: >
6+
Types of applications you can build with fireact.dev
7+
---
8+
9+
fireact.dev is suitable for various SaaS applications, including:
10+
11+
* Subscription-based services
12+
* Team collaboration tools
13+
* Business applications
14+
* Content management systems
15+
* Online platforms
16+
* Any application requiring user authentication and subscription management
17+
18+
Example use cases:
19+
- Project management tools
20+
- Online learning platforms
21+
- Business analytics dashboards
22+
- Team collaboration software
23+
- Content subscription services
24+
- Customer portals
25+
- Membership sites
26+
- Digital product platforms

‎content/faq/contributing.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "How can I contribute?"
3+
linkTitle: "Contributing"
4+
weight: 9
5+
description: >
6+
Ways to contribute to fireact.dev
7+
---
8+
9+
As an open-source project, we welcome contributions:
10+
11+
* Submit issues on GitHub
12+
* Contribute code through pull requests
13+
* Improve documentation
14+
* Share your experience and help others
15+
* Suggest new features
16+
17+
Ways to get involved:
18+
- Report bugs and issues
19+
- Submit feature requests
20+
- Help improve documentation
21+
- Share your use cases
22+
- Participate in discussions
23+
- Help answer questions
24+
- Write tutorials or blog posts
25+
- Share fireact.dev with others

‎content/faq/customization.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Can I customize the UI and features?"
3+
linkTitle: "Customization"
4+
weight: 5
5+
description: >
6+
Understanding customization options in fireact.dev
7+
---
8+
9+
Yes, fireact.dev is highly customizable:
10+
11+
* Built with TailwindCSS for easy styling customization
12+
* Component-based architecture allows easy modifications
13+
* Clear separation of concerns makes it easy to add or modify features
14+
* All source code is available and can be customized to your needs
15+
16+
You can customize:
17+
- UI components and styling
18+
- Authentication flows
19+
- Team permission structures
20+
- Subscription plans and features
21+
- Billing and invoice layouts
22+
- Email templates and notifications

‎content/faq/features.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "What features are included?"
3+
linkTitle: "Features"
4+
weight: 2
5+
description: >
6+
Overview of features included in fireact.dev
7+
---
8+
9+
fireact.dev includes essential features for building SaaS applications:
10+
11+
* Complete authentication system (sign-up, sign-in, password reset)
12+
* User profile management
13+
* Subscription management with Stripe integration
14+
* Team collaboration with role-based permissions
15+
* Billing portal and invoice management
16+
* Internationalization support
17+
* Responsive layouts with TailwindCSS
18+
* Firebase integration (Auth, Firestore, Cloud Functions)

‎content/faq/getting-help.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Where can I get help?"
3+
linkTitle: "Getting Help"
4+
weight: 10
5+
description: >
6+
How to get help with fireact.dev
7+
---
8+
9+
There are several ways to get help:
10+
11+
* Check our comprehensive documentation
12+
* Visit our GitHub repository
13+
* Join our community discussions
14+
* Report issues on GitHub
15+
* Contact our support team
16+
17+
Support channels:
18+
- Documentation: Detailed guides and API references
19+
- GitHub Issues: Bug reports and feature requests
20+
- Community Discussions: Ask questions and share experiences
21+
- GitHub Repository: Source code and examples
22+
- Support Team: Direct assistance when needed
23+
24+
If you haven't found the answer to your question, please feel free to contact us or visit our GitHub repository. Our community and team are here to help!

‎content/faq/local-development.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "How do I handle local development?"
3+
linkTitle: "Local Development"
4+
weight: 7
5+
description: >
6+
Understanding local development with fireact.dev
7+
---
8+
9+
fireact.dev includes support for Firebase emulators, allowing you to:
10+
11+
* Develop locally without affecting production data
12+
* Test authentication flows
13+
* Simulate cloud functions
14+
* Test Stripe webhooks locally
15+
* Debug and develop offline
16+
17+
The emulators provide a complete local development environment where you can:
18+
- Test authentication with dummy accounts
19+
- Develop and test cloud functions
20+
- Work with Firestore data locally
21+
- Test Stripe integrations with test keys
22+
- Debug your application without affecting production
23+
24+
This makes it safe and efficient to develop and test your application before deploying to production.

‎content/faq/modularity.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Do I need to use all the features?"
3+
linkTitle: "Modularity"
4+
weight: 3
5+
description: >
6+
Understanding the modular structure of fireact.dev
7+
---
8+
9+
No, fireact.dev is built with modularity in mind. The framework consists of three main packages:
10+
11+
* @fireact.dev/core - Essential authentication and user management
12+
* @fireact.dev/saas - Subscription management and billing
13+
* @fireact.dev/saas-cloud-functions - Backend processing and Stripe integration
14+
15+
You can start with just the core package for basic authentication features and add other packages as needed. Note that if you want to use the SaaS features, you'll need both @fireact.dev/saas and @fireact.dev/saas-cloud-functions packages together.

‎content/faq/prerequisites.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: "What are the prerequisites?"
3+
linkTitle: "Prerequisites"
4+
weight: 4
5+
description: >
6+
Required tools and knowledge for using fireact.dev
7+
---
8+
9+
To use fireact.dev, you'll need:
10+
11+
* Node.js and npm installed
12+
* A Firebase project (Blaze plan required for cloud functions)
13+
* A Stripe account for payment processing (if using SaaS features)
14+
* Basic knowledge of React and TypeScript
15+
* Firebase CLI installed for deployment
16+
17+
The Blaze plan (pay-as-you-go) is required for Firebase Cloud Functions, which are needed for the SaaS features. However, if you're only using the core package, you can use the free Spark plan.

‎content/faq/production-ready.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Is fireact.dev production-ready?"
3+
linkTitle: "Production Ready"
4+
weight: 6
5+
description: >
6+
Understanding the production readiness of fireact.dev
7+
---
8+
9+
Yes, fireact.dev is designed for production use with:
10+
11+
* TypeScript for type safety and better code quality
12+
* Comprehensive error handling
13+
* Security best practices
14+
* Scalable Firebase backend
15+
* Production-tested Stripe integration
16+
* Support for Firebase emulators in development
17+
18+
The framework follows industry best practices for:
19+
- Security
20+
- Performance
21+
- Scalability
22+
- Error handling
23+
- Data validation
24+
- User authentication
25+
- Payment processing

0 commit comments

Comments
 (0)