Skip to content

Commit

Permalink
main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jake-figma committed Jun 20, 2024
1 parent 95f2fba commit fc55c6a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@

Using Figma's [Code Connect](https://github.com/figma/code-connect).

## Auth

Create an API token with Code Connect scope (add Dev Resources and Variables scopes as well if you want to use those integrations). Duplicate `.env-rename` and rename it to `.env` and put your token there. It will be ignored from git.

## Codebase setup

- `npm i` to install dependencies
- `npm run app:dev` will run server at [localhost:8000](http://localhost:8000) which renders contents of [App.tsx](src/App.tsx).
- `npm run storybook` to start storybook at [localhost:6006](http://localhost:6006)

## Scripts

Some example integrations are available in `scripts` directory. They may require additional API scope that your org may or may not have access to. Where possible, there are some plugins examples to help fill gaps.

0 comments on commit fc55c6a

Please sign in to comment.