mirror of
https://github.com/formbricks/formbricks.git
synced 2026-05-24 11:39:31 -05:00
Rename Projects to Workspaces in docs
This commit is contained in:
Johannes
@@ -16,7 +16,7 @@ Here are the requirements for setting up Formbricks on Linux:
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. **Clone the project & move into the directory:**
|
||||
1. **Clone the repository and move into the directory:**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/formbricks/formbricks && cd formbricks
|
||||
|
||||
@@ -16,7 +16,7 @@ icon: "apple"
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. **Clone the project & change directory:**
|
||||
1. **Clone the repository and change directory:**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/formbricks/formbricks && cd formbricks
|
||||
|
||||
@@ -19,7 +19,7 @@ icon: "windows"
|
||||
|
||||
**Steps (Using WSL2):**
|
||||
|
||||
1. **Open your WSL2 terminal and clone the project:**
|
||||
1. **Open your WSL2 terminal and clone the repository:**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/formbricks/formbricks && cd formbricks
|
||||
|
||||
@@ -4,12 +4,12 @@ description: Learn how to setup formbricks locally and build custom integrations
|
||||
icon: "code"
|
||||
---
|
||||
|
||||
Welcome to the Development section of Formbricks! This guide is designed to help you get started with setting up the project locally, contributing to the Formbricks codebase, and customizing it to suit your needs.
|
||||
Welcome to the Development section of Formbricks! This guide is designed to help you get started with setting up the repository locally, contributing to the Formbricks codebase, and customizing it to suit your needs.
|
||||
|
||||
Whether you're a seasoned developer or just getting started, you'll find valuable information on how to:
|
||||
|
||||
- **Set Up Locally**: Step-by-step instructions to clone the repository, install dependencies, and run Formbricks on your local machine.
|
||||
- **Contribute**: Guidelines on how to contribute to the project, including coding standards, submitting pull requests, and collaborating with other developers.
|
||||
- **Contribute**: Guidelines on how to contribute to the codebase, including coding standards, submitting pull requests, and collaborating with other developers.
|
||||
- **Customize**: Tips and tricks for customizing Formbricks to better fit your specific use cases, including modifying components and extending functionality.
|
||||
|
||||
Dive in and start building with Formbricks today!
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
title: File and Directory Org.
|
||||
description: This document outlines the structure and organization of files and directories in the Formbricks codebase, providing guidelines for maintaining consistency and clarity across the project.
|
||||
description: This document outlines the structure and organization of files and directories in the Formbricks codebase, providing guidelines for maintaining consistency and clarity across the repository.
|
||||
icon: folder-tree
|
||||
---
|
||||
|
||||
## Project Structure Overview
|
||||
## Repository Structure Overview
|
||||
|
||||
The Formbricks codebase follows a monorepo structure using pnpm workspaces, with two main directories:
|
||||
|
||||
@@ -246,7 +246,7 @@ Each package maintains its own configuration files:
|
||||
|
||||
Following these organizational patterns ensures:
|
||||
|
||||
* Consistent code structure across the project
|
||||
* Consistent code structure across the repository
|
||||
|
||||
* Easy navigation and maintenance
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Naming Conventions
|
||||
description: This section outlines the guidelines for naming conventions across the codebase, ensuring consistency and clarity in the project.
|
||||
description: This section outlines the guidelines for naming conventions across the codebase, ensuring consistency and clarity in the codebase.
|
||||
icon: input-text
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Code Formatting"
|
||||
description: "Standards for consistent code formatting across the Formbricks project"
|
||||
description: "Standards for consistent code formatting across the Formbricks codebase"
|
||||
icon: code
|
||||
---
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Our codebase follows the Vercel Engineering Style Guide conventions.
|
||||
|
||||
### ESLint Configuration
|
||||
|
||||
We maintain three primary ESLint configurations for different project types:
|
||||
We maintain three primary ESLint configurations for different package types:
|
||||
|
||||
1. **Library Configuration** (for packages):
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ erDiagram
|
||||
1. **Organization**
|
||||
|
||||
- Top-level entity for multi-tenancy
|
||||
- Contains multiple workspaces and team members
|
||||
- Contains multiple Workspaces and team members
|
||||
- Manages billing and whitelabel settings
|
||||
|
||||
2. **Workspace**
|
||||
@@ -72,8 +72,8 @@ erDiagram
|
||||
- Controls branding and display settings
|
||||
|
||||
3. **WorkspaceTeam**
|
||||
- Maps teams to workspaces
|
||||
- Controls workspace-level access permissions
|
||||
- Maps teams to Workspaces
|
||||
- Controls Workspace-level access permissions
|
||||
- Enables scoped collaboration across teams
|
||||
|
||||
### Survey Management
|
||||
@@ -111,7 +111,7 @@ erDiagram
|
||||
|
||||
3. **Team**
|
||||
- Groups users within organizations
|
||||
- Controls workspace access permissions
|
||||
- Controls Workspace access permissions
|
||||
- Facilitates collaborative survey management
|
||||
|
||||
## Data Isolation
|
||||
@@ -120,20 +120,20 @@ The database schema ensures proper data isolation through:
|
||||
|
||||
1. **Organization-level isolation**
|
||||
|
||||
- Each organization has its own workspaces
|
||||
- Each organization has its own Workspaces
|
||||
- Users can belong to multiple organizations
|
||||
- Resources are scoped to organizations
|
||||
|
||||
2. **Workspace-level isolation**
|
||||
2. **Environment-level isolation**
|
||||
|
||||
- Independent surveys, contacts, action classes, and integrations
|
||||
- Isolated API key workspace assignments
|
||||
- Isolated API key Workspace assignments
|
||||
- Workspace-specific configuration and styling defaults
|
||||
|
||||
3. **Team-based access isolation**
|
||||
|
||||
- Teams are linked to workspaces through `WorkspaceTeam`
|
||||
- Permissions are scoped per workspace
|
||||
- Teams are linked to Workspaces through `WorkspaceTeam`
|
||||
- Permissions are scoped per Workspace
|
||||
- Access can be delegated without exposing all organization resources
|
||||
|
||||
|
||||
@@ -158,7 +158,7 @@ Formbricks stores all data in PostgreSQL tables. Here's a comprehensive list of
|
||||
| Account | Stores third-party authentication accounts (OAuth) and their tokens |
|
||||
| ActionClass | Defines triggerable events that can launch surveys |
|
||||
| ApiKey | Stores API authentication keys for organization-level access |
|
||||
| ApiKeyWorkspace | Maps API keys to the workspaces they can access |
|
||||
| ApiKeyWorkspace | Maps API keys to the Workspaces they can access |
|
||||
| Contact | Records information about user that can receive and respond to surveys |
|
||||
| ContactAttribute | Stores attribute values for contacts (e.g., role, company size) |
|
||||
| ContactAttributeKey | Defines available attribute types for contacts |
|
||||
@@ -169,7 +169,7 @@ Formbricks stores all data in PostgreSQL tables. Here's a comprehensive list of
|
||||
| Invite | Manages pending invitations to join organizations |
|
||||
| Language | Defines supported languages for multi-lingual surveys |
|
||||
| Membership | Links users to organizations with specific roles |
|
||||
| Organization | Top-level container for workspaces and team management |
|
||||
| Organization | Top-level container for Workspaces and team management |
|
||||
| Response | Stores survey responses and associated metadata |
|
||||
| Segment | Defines groups of contacts based on attributes |
|
||||
| Survey | Stores survey configurations, questions, and display rules |
|
||||
@@ -181,7 +181,7 @@ Formbricks stores all data in PostgreSQL tables. Here's a comprehensive list of
|
||||
| TagsOnResponses | Junction table linking tags to responses |
|
||||
| Team | Groups users within organizations |
|
||||
| TeamUser | Links users to teams with specific roles |
|
||||
| WorkspaceTeam | Manages team access permissions to workspaces |
|
||||
| WorkspaceTeam | Manages team access permissions to Workspaces |
|
||||
| User | Stores user account information and preferences |
|
||||
| Webhook | Manages webhook endpoints for event notifications |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ This documentation only applies to Formbricks Cloud instances. On-premise deploy
|
||||
|
||||
## Multi-Tenancy in Formbricks Cloud
|
||||
|
||||
Formbricks Cloud is architected as a true multi-tenant system where each organization operates in its own isolated workspace while sharing the underlying infrastructure. This approach allows multiple organizations to use the platform independently without visibility into each other's data.
|
||||
Formbricks Cloud is architected as a true multi-tenant system where each organization operates in its own isolated Workspace while sharing the underlying infrastructure. This approach allows multiple organizations to use the platform independently without visibility into each other's data.
|
||||
|
||||
### Organizational Structure
|
||||
|
||||
@@ -56,10 +56,10 @@ The multi-tenant architecture in Formbricks Cloud is built around three key leve
|
||||
|
||||
### 2. Workspace-Level Isolation
|
||||
|
||||
Within each organization, further isolation is maintained through workspaces:
|
||||
Within each organization, further isolation is maintained through Workspaces:
|
||||
|
||||
- Organizations can have multiple workspaces to separate different applications or product lines
|
||||
- Complete separation of resources between workspaces:
|
||||
- Organizations can have multiple Workspaces to separate different applications or product lines
|
||||
- Complete separation of resources between environments:
|
||||
- Surveys and responses
|
||||
- Contacts and attributes
|
||||
- Action classes and triggers
|
||||
@@ -67,19 +67,19 @@ Within each organization, further isolation is maintained through workspaces:
|
||||
- Webhooks and notifications
|
||||
- Segments and targeting rules
|
||||
- Workspace-specific configuration, branding, and style settings
|
||||
- Language settings and customizations are workspace-specific
|
||||
- Language settings and customizations are Workspace-specific
|
||||
|
||||
### 3. Team-Based Access Isolation
|
||||
|
||||
Team access is scoped per workspace:
|
||||
Team access is scoped per Workspace:
|
||||
|
||||
- Teams can be granted access to specific workspaces via workspace-team mapping
|
||||
- Permissions are applied at the workspace level for finer-grained access control
|
||||
- Users can collaborate in one workspace without being granted access to all organization resources
|
||||
- Teams can be granted access to specific Workspaces via Workspace-team mapping
|
||||
- Permissions are applied at the Workspace level for finer-grained access control
|
||||
- Users can collaborate in one Workspace without being granted access to all organization resources
|
||||
|
||||
## Data Security in the Multi-Tenant Model
|
||||
|
||||
Formbricks ensures data security in its multi-tenant workspace model through:
|
||||
Formbricks ensures data security in its multi-tenant Workspace model through:
|
||||
|
||||
- **Database Layer Isolation**:
|
||||
- Foreign key constraints enforce data isolation
|
||||
@@ -92,7 +92,7 @@ Formbricks ensures data security in its multi-tenant workspace model through:
|
||||
- Multi-factor authentication support
|
||||
|
||||
- **API Access Control**:
|
||||
- API keys are scoped to specific workspaces
|
||||
- API keys are scoped to specific Workspaces
|
||||
- Rate limiting per organization
|
||||
- Request validation and sanitization
|
||||
|
||||
|
||||
Reference in New Issue
Block a user