Step 1: Create Your 1fe Instance
In this first part of our proof of concept tutorial, youโll set up a local 1fe instance from scratch. This will give you hands-on experience with the core architecture and help you understand how 1fe works at a fundamental level.
What Youโll Learn
- How to scaffold a new 1fe instance
๐ Prerequisites
- Node.js 22.x.x+
- Yarn 4.x.x+
๐ง Manual Installation
- Scaffold a starter application:
npx @1fe/create-1fe-app <test-app-name>
- Clone the 1fe widget starter kit (WSK):
git clone https://github.com/docusign/1fe-widget-starter-kit.git
- Set up both the repos:
First you need to build the 1fe monorepo and the starter kit.
cd <test-app-name> # adjust this to fit your directory structureyarn && yarn build
Then, you need to set up the starter kit.
cd 1fe-widget-starter-kit # adjust this to fit your directory structureyarn
- Run the starter app development server
cd <test-app-name> # adjust this to fit your directory structureyarn dev
You can now visit your instance at http://localhost:3000. You will see this mirror our demo website here. We will take a look later at how to customize this instance.
- Run the development server for the WSK
cd 1fe-widget-starter-kit/ # adjust this to fit your directory structureyarn dev
This will open WSK at the following link.
You now have a functioning 1fe instance running locally! ๐
๐ฏ What Youโve Accomplished
- โ Set up a complete 1fe development environment
- โ Created your first 1fe instance with server and shell components
- โ Understood the basic architecture of how 1fe works
๐ Next Step
Now that you have a working 1fe instance, itโs time to learn how to build widgets and understand the development workflow.
โ Step 2: Develop Your First Widget
Continue to learn the development workflow and build a custom widget.