You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/reference/terminology.mdx
+17-31Lines changed: 17 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,34 +20,32 @@ This section provides definitions for common terms used throughout the 1fe ecosy
20
20
21
21
### 1fe
22
22
23
-
A micro-frontend platform that standardizes development, deployment, and execution of frontend experiences. 1fe provides shared utilities and governance controls through a centralized platform team while allowing individual teams to focus on creating unique user experiences.
23
+
A micro-frontend platform that standardizes development, deployment, and execution of frontend experiences. 1fe provides shared utilities and governance controls through a centralized platform team while allowing individual teams to focus on creating unique user experiences. The main repository is available on [GitHub](https://github.com/docusign/1fe).
24
24
25
-
### 1fe Instance[[memory:5051784]]
25
+
### 1fe Instance
26
26
27
-
A hosted application that runs the 1fe platform for your organization. This is the main application that serves as the runtime environment for all widgets and plugins in your ecosystem.
27
+
A hosted application that runs the 1fe platform for your organization. This is the main application that serves as the runtime environment for all widgets and plugins in your ecosystem. You can get started with the [1fe-starter-app](https://github.com/docusign/1fe-starter-app) template.
28
28
29
29
### CI/CD
30
30
31
-
Continuous Integration/Continuous Deployment. 1fe provides standardized pipeline templates through `1fe-ci-cd` to ensure consistent building, testing, and deployment processes across all widgets and plugins.
31
+
Continuous Integration/Continuous Deployment. 1fe provides standardized pipeline templates through [1fe-ci-cd](https://github.com/docusign/1fe-ci-cd) to ensure consistent building, testing, and deployment processes across all widgets and plugins.
32
32
33
33
### CDN
34
34
35
35
Content Delivery Network. A distributed network of servers used to deliver widget assets efficiently. 1fe deployments typically use a CDN to serve widget bundles for optimal performance.
36
36
37
37
### CLI
38
38
39
-
Command Line Interface. The `@1fe/cli` package provides the primary tool for building, developing, and validating widgets and plugins in the 1fe ecosystem.
39
+
Command Line Interface. The [@1fe/cli](https://www.npmjs.com/package/@1fe/cli) package provides the primary tool for building, developing, and validating widgets and plugins in the 1fe ecosystem.
40
40
41
41
### Contextual Injection
42
42
43
-
A mechanism where the `@1fe/shell` package is intercepted at runtime and replaced with platform-specific utilities contextualized to each widget. This enables widgets to access platform utilities without prop drilling.
43
+
A mechanism where the [@1fe/shell](https://www.npmjs.com/package/@1fe/shell) package is intercepted at runtime and replaced with platform-specific utilities contextualized to each widget. This enables widgets to access platform utilities without prop drilling.
44
44
45
45
### Ecosystem
46
46
47
47
The complete set of packages, repositories, tools, and standards that make up the 1fe platform, including core packages, starter kits, templates, and community widgets.
48
48
49
-
## Component Types
50
-
51
49
### Widget
52
50
53
51
Any packaged JavaScript logic that runs in a browser. Widgets live in their own repositories, control their own release lifecycle, and can be embedded within other widgets or plugins. They follow 1fe standards and are never permitted to be IIFEs (Immediately Invoked Function Expressions).
@@ -60,15 +58,15 @@ A widget that is tied to a specific URL route. Plugins represent full page exper
60
58
61
59
A widget where the version can be locked to a specific version by the host widget or plugin. If not pinned, the latest version is automatically used.
62
60
63
-
### Design System Component
61
+
### Live Configurations
64
62
65
-
A simple, atomic presentation component with minimal logic that can be widely reused from a design perspective. These are typically part of a shared design system rather than independent widgets.
63
+
Dynamic configuration files that specify widget versions, CDN locations, and deployment status. These enable runtime updates without server restarts.
66
64
67
65
## 🔧 Technical Components
68
66
69
67
### Shell
70
68
71
-
The main application shell provided by `@1fe/shell` that includes common UI components (headers, navigation) and shared platform utilities. The shell is delivered as part of the initial HTML response and provides the foundation for all widget execution.
69
+
The main application shell provided by [@1fe/shell](https://www.npmjs.com/package/@1fe/shell) that includes common UI components (headers, navigation) and shared platform utilities. The shell is delivered as part of the initial HTML response and provides the foundation for all widget execution.
72
70
73
71
### Sandbox
74
72
@@ -82,23 +80,15 @@ Props provided by the 1fe platform to widgets, including environment information
82
80
83
81
Optional props passed from a parent widget to a child widget for integration purposes. These enable feature flags, configuration APIs, and data sharing between widgets.
84
82
85
-
### Monorepo
86
-
87
-
A single repository containing multiple related packages. The core 1fe packages are maintained in a monorepo structure for easier development and coordination.
88
-
89
83
## 🛠️ Development Tools
90
84
91
85
### 1fe Playground
92
86
93
-
A special plugin that provides a sandbox environment for developing and testing widgets in isolation during local development. It allows developers to mock platform props and test widget behavior before deployment.
87
+
A special plugin that provides a sandbox environment for developing and testing widgets in isolation during local development. It allows developers to mock platform props and test widget behavior before deployment. Available in the [1fe-playground](https://github.com/docusign/1fe-playground) repository.
94
88
95
-
### Starter Kit
89
+
### 1fe Widget Starter Kit
96
90
97
-
Template repositories (like `1fe-widget-starter-kit`) that provide pre-configured setups for creating new widgets and plugins, including build scripts, CI/CD configurations, and best practices.
98
-
99
-
### Live Configurations
100
-
101
-
Dynamic configuration files that specify widget versions, CDN locations, and deployment status. These enable runtime updates without server restarts.
91
+
Template repository ([1fe-widget-starter-kit](https://github.com/docusign/1fe-widget-starter-kit)) that provides a template for building widgets within the 1fe ecosystem. This starter kit provides the foundation, examples, and best practices for developing production-ready widgets.
102
92
103
93
## Development Patterns
104
94
@@ -110,10 +100,6 @@ An architectural approach where frontend applications are decomposed into smalle
110
100
111
101
The import pattern used to access platform utilities: `import { platformProps } from "@1fe/shell"`. This syntax is intercepted and replaced with actual platform utilities at runtime.
112
102
113
-
### Lazy Loading
114
-
115
-
The practice of loading widgets on-demand rather than upfront. 1fe automatically lazy-loads all widgets to improve initial page load performance.
116
-
117
103
### Guest Development
118
104
119
105
Development work done by teams outside the core platform team. 1fe aims to reduce guest development friction by providing standardized tools and clear boundaries.
@@ -122,19 +108,19 @@ Development work done by teams outside the core platform team. 1fe aims to reduc
122
108
123
109
### @1fe/cli
124
110
125
-
The command-line tool for building, developing, and validating widgets. Key commands include `build`, `contracts`, and `dev`.
111
+
The command-line tool for building, developing, and validating widgets. Key commands include `build`, `contracts`, and `dev`. Available on [npm](https://www.npmjs.com/package/@1fe/cli) and [GitHub](https://github.com/docusign/1fe/tree/main/packages/cli).
126
112
127
113
### @1fe/server
128
114
129
-
The core Express.js server package that provides the runtime backbone for 1fe instances, including configuration polling and asset serving.
115
+
The core Express.js server package that provides the runtime backbone for 1fe instances, including configuration polling and asset serving. Available on [npm](https://www.npmjs.com/package/@1fe/server) and [GitHub](https://github.com/docusign/1fe/tree/main/packages/1fe-server).
130
116
131
117
### @1fe/shell
132
118
133
-
Provides the application shell, layout components, and shared platform utilities that are available to all widgets at runtime.
119
+
Provides the application shell, layout components, and shared platform utilities that are available to all widgets at runtime. Available on [npm](https://www.npmjs.com/package/@1fe/shell) and [GitHub](https://github.com/docusign/1fe/tree/main/packages/1fe-shell).
134
120
135
-
### create-1fe-app
121
+
### @1fe/create-1fe-app
136
122
137
-
A scaffolding tool for quickly creating new 1fe instances by answering setup questions in the terminal.
123
+
A scaffolding tool for quickly creating new 1fe instances by answering setup questions in the terminal. Available on [npm](https://www.npmjs.com/package/@1fe/create-1fe-app) and [GitHub](https://github.com/docusign/1fe/tree/main/packages/create-1fe-app).
import { getBaseConfig } from"@1fe/sample-widget-base-config"; // this is the redistributed package for the organization
148
+
149
+
const configuration:OneFeConfiguration= {
150
+
baseConfig: getBaseConfig,
151
+
};
152
+
153
+
exportdefaultconfiguration;
157
154
```
158
155
159
156
## 🚀 Starting the Development Server
160
157
158
+
:::note[1fe Instance Required]
159
+
**Important:** This command requires a running 1fe instance to work properly. If your organization doesn't have a 1fe instance set up yet, you'll need to follow [Tutorial 1: Setup and Deploy a 1fe POC](/tutorials/setup-and-deploy-1fe-poc/) to get your 1fe instance up and running locally first.
160
+
:::
161
+
161
162
Now let's get your widget running locally:
162
163
163
164
```bash
164
165
# Start the development server
165
166
yarn dev
166
-
167
-
# Or with npm
168
-
npm run dev
169
167
```
170
168
171
169
You should see output similar to:
172
170
173
171
```
174
-
✓ Widget development server started
175
-
✓ Widget bundle available at: http://localhost:8080/js/1fe-bundle.js
Save the file and watch your terminal - you should see the widget recompile automatically.
249
+
Save the file and watch your terminal - you should see the widget recompile automatically and your browser should show a pretty banner at the top of the page with a close button.
222
250
223
251
## 📁 Understanding Widget Architecture
224
252
@@ -244,20 +272,6 @@ The typical development cycle is:
244
272
3.**Build** - Compile with `yarn build:widget`
245
273
4.**Deploy** - Push to your organization's deployment pipeline
246
274
247
-
## ✅ Validation Checklist
248
-
249
-
Before moving to the next step, ensure:
250
-
251
-
<divclass="prose">
252
-
253
-
-[ ]**Node.js 18+** installed and working
254
-
-[ ]**Widget starter kit** cloned and dependencies installed
255
-
-[ ]**Development server** running without errors
256
-
-[ ]**Bundle URL** accessible at http://localhost:8080/js/1fe-bundle.js
257
-
-[ ]**Hot reloading** working when you make code changes
258
-
259
-
</div>
260
-
261
275
## 🎉 Success!
262
276
263
277
Congratulations! You now have a fully functional widget development environment. Your widget is compiled, served locally, and ready for development.
@@ -268,10 +282,6 @@ Now that your development environment is ready, let's learn how to use the 1fe P
268
282
269
283
**→ [Step 2: Using the Playground for Development](/tutorials/developing-your-first-widget/using-playground/)**
270
284
271
-
In the next step, you'll load your widget in the playground and start the interactive development workflow.
285
+
In the next step, we will explore the playground to learn more of it's features.
272
286
273
287
---
274
-
275
-
:::tip[Organization Integration]
276
-
Once you're comfortable with this standard workflow, ask your platform team about organization-specific development tools. The concepts you're learning here apply to any custom tooling your organization provides!
0 commit comments