Skip to content

Commit 32ed9b6

Browse files
chaomingchaoming
committed
docs: restructure documentation and clarify package relationships
1 parent be47106 commit 32ed9b6

File tree

6 files changed

+690
-99
lines changed

6 files changed

+690
-99
lines changed

‎content/_index.md‎

Lines changed: 66 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Fireact Documentation"
2+
title: "fireact.dev Documentation"
33
linkTitle: "Documentation"
44
type: "docs"
55
no_list: true
@@ -11,55 +11,85 @@ cascade:
1111
---
1212

1313
{{% pageinfo %}}
14-
This is the main documentation section for Fireact. Here you'll find comprehensive guides and documentation to help you start working with Fireact as quickly as possible.
14+
This is the main documentation section for fireact.dev. Here you'll find comprehensive guides and documentation to help you start working with fireact.dev as quickly as possible.
1515
{{% /pageinfo %}}
1616

17-
## Getting Started
17+
## What is fireact.dev?
1818

19-
Before you begin, make sure you have the following installed:
19+
fireact.dev is a comprehensive open-source framework for building production-ready SaaS applications with Firebase, React, TypeScript, and Stripe integration. It provides a complete foundation for modern web applications.
2020

21-
- Node.js (version 14 or higher)
22-
- npm or yarn
23-
- Git
21+
## Package Structure
2422

25-
### Installation
23+
fireact.dev is organized into three main packages:
2624

27-
You can create a new Fireact project using our CLI tool:
25+
### Core Package (@fireact.dev/core)
2826

29-
```bash
30-
npx create-fireact-app my-app
31-
cd my-app
32-
```
27+
The core package provides essential features required for any web application:
3328

34-
Or clone the repository directly:
29+
- Complete authentication system
30+
- User profile management
31+
- Email/password and social authentication
32+
- Account settings and management
33+
- Internationalization support
3534

36-
```bash
37-
git clone https://github.com/username/fireact.git
38-
cd fireact
39-
npm install
40-
```
35+
This package is required for all fireact.dev applications, including those that use the SaaS features.
4136

42-
### Configuration
37+
### SaaS Packages
4338

44-
1. Create a new Firebase project at [Firebase Console](https://console.firebase.google.com)
45-
2. Copy your Firebase configuration
46-
3. Create a `.env` file in your project root
39+
The SaaS functionality is provided through two complementary packages that work together:
4740

48-
## Core Concepts
41+
#### Frontend Package (@fireact.dev/saas)
42+
- Multiple subscription plans
43+
- Stripe integration for payments
44+
- Billing portal and invoice management
45+
- Team collaboration and workspaces
46+
- Role-based access control
47+
- Permission level management
48+
- User invitations and team management
4949

50-
Learn about the main concepts and architecture of Fireact:
50+
#### Backend Package (@fireact.dev/saas-cloud-functions)
51+
- Stripe webhook handling
52+
- Subscription processing
53+
- Payment method management
54+
- Team operations
55+
- Billing operations
56+
- Invoice generation
5157

52-
- Firebase Integration
53-
- Authentication
54-
- Database Management
55-
- Storage Solutions
56-
- Cloud Functions
58+
**Note:** Both SaaS packages require the core package (@fireact.dev/core) as a foundation, and must be used together to implement the complete SaaS functionality.
5759

58-
## Guides
60+
## Tech Stack
5961

60-
Explore our detailed guides for specific features and use cases:
62+
- **Frontend**: React, TypeScript, TailwindCSS
63+
- **Backend**: Firebase (Authentication, Firestore, Cloud Functions)
64+
- **Payment Processing**: Stripe
65+
- **Development Tools**: Vite, ESLint, PostCSS
6166

62-
- User Management
63-
- Data Modeling
64-
- Security Rules
65-
- Deployment
67+
## Project Structure
68+
69+
The framework is organized into several key components:
70+
71+
- **Core Features**: Essential authentication and user management
72+
- **SaaS Features**: Subscription, billing, and team management
73+
- Frontend components and interfaces
74+
- Backend cloud functions and processing
75+
- **Development Tools**: Local development and testing support
76+
77+
## Documentation Structure
78+
79+
Our documentation is organized into two main sections:
80+
81+
1. **Core Documentation**: Essential features and setup
82+
- Authentication system
83+
- User profile management
84+
- Account settings
85+
- Basic configuration
86+
87+
2. **SaaS Documentation**: Advanced features
88+
- Frontend components and features
89+
- Backend cloud functions
90+
- Subscription management
91+
- Payment processing
92+
- Team collaboration
93+
- Permission management
94+
95+
Each section includes its own getting started guide and detailed documentation.

‎content/core/_index.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: "Core Package"
3+
linkTitle: "Core"
4+
weight: 2
5+
description: >
6+
Essential authentication and user management features
7+
---
8+
9+
## Overview
10+
11+
The @fireact.dev/core package provides essential features for web applications built with Firebase and React. It handles user authentication, profile management, and account settings with a complete set of pre-built components and utilities.
12+
13+
## Features
14+
15+
### Authentication System
16+
- Email/password authentication
17+
- Social login providers support
18+
- Password reset functionality
19+
- Protected route handling
20+
21+
### User Profile Management
22+
- User profile display and editing
23+
- Name and email management
24+
- Password change functionality
25+
- Account deletion options
26+
27+
### Account Settings
28+
- User preferences
29+
- Account security options
30+
- Profile customization
31+
- Email verification
32+
33+
### Development Support
34+
- Firebase emulator integration
35+
- TypeScript support
36+
- Internationalization (i18n)
37+
- Responsive UI components
38+
39+
## Components
40+
41+
### Authentication Components
42+
- `<SignIn />` - Sign in form with social options
43+
- `<SignUp />` - Registration form
44+
- `<ResetPassword />` - Password reset form
45+
- `<PrivateRoute />` - Protected route wrapper
46+
47+
### Profile Components
48+
- `<Profile />` - User profile display/edit
49+
- `<EditName />` - Name editor
50+
- `<EditEmail />` - Email update
51+
- `<ChangePassword />` - Password change
52+
- `<DeleteAccount />` - Account deletion
53+
54+
### Layout Components
55+
- `<AuthenticatedLayout />` - Layout for protected pages
56+
- `<PublicLayout />` - Layout for public pages
57+
- `<Message />` - Notification display
58+
- `<Dashboard />` - User dashboard
59+
60+
### Context Providers
61+
- `<AuthProvider />` - Authentication context
62+
- `<ConfigProvider />` - Configuration context
63+
- `<LoadingProvider />` - Loading state management
64+
65+
## Tech Stack
66+
67+
- React with TypeScript
68+
- Firebase Authentication
69+
- Firebase Firestore
70+
- TailwindCSS
71+
- i18next for internationalization
72+
73+
## Getting Started
74+
75+
Visit our [Getting Started Guide]({{< ref "/core/getting-started" >}}) to begin using the core package.

0 commit comments

Comments
 (0)