https://github.com/reiddraper/week-planner-widget
https://github.com/reiddraper/week-planner-widget
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/reiddraper/week-planner-widget
- Owner: reiddraper
- Created: 2023-04-13T21:21:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T18:39:54.000Z (over 1 year ago)
- Last Synced: 2025-03-11T11:51:44.075Z (over 1 year ago)
- Language: TypeScript
- Size: 417 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @figma/create-widget
This repo was created by @figma/create-widget
## Getting started with widget development
Run the following command to start building your widget
```bash
npm run dev
```
1. Log in to your account and open the Figma desktop app
2. You can open any existing FigJam document or create a new one.
3. Go to Menu > Widgets > Development > "Import widget from manifest..."
4. Select the manifest.json in this folder
## Organization
This widget uses:
- [esbuild](https://esbuild.github.io/) for bundling
- [typescript](https://www.typescriptlang.org/) for typechecking
| file/folder | description |
| ------------- | -------------------------------------------------------------------------------- |
| manifest.json | The widget's [manifest.json](https://www.figma.com/widget-docs/widget-manifest/) |
| src/ | Contains the widget code |
### `npm run dev`
This is the only command you need to run in development. It will start the following processes for you:
- bundling
- typechecking
### `npm run build`
This runs bundling with minification turned on. You should run this command before releasing your widget.
### `npm run test`
This runs typechecking and makes sure that your widget builds without errors.