Skip to content

Latest commit

 

History

History
184 lines (115 loc) · 8.04 KB

README.md

File metadata and controls

184 lines (115 loc) · 8.04 KB
Raw

Important notice

Clapy has stopped operating. We are thankful for your support. After years of generating projects code from design, it's time to move forward.

Clapy

Clapy is a Figma plugin that generates React and Angular components and pages from your Figma design.

For usage, please refer to the documentation.

This readme describes how to get started with the source code. The below instructions are opinionated, initially written for our internal team.

The Figma plugin sources also show an example about how we could have a relatively good developer experiences compared to alternative templates available out there.

  • Preview in the browser (In dev mode, the plugin is split in 2 parts: the front in the browser and the back in Figma, as plugin. They communicate through websockets)
  • Hot-reload the front with vitejs (super fast)
  • build with esbuild (super fast)
  • Example of authentication with Auth0 (the token management can be improved when signing in)
  • ...

Setup

  • Use nvm to install NodeJS (makes it much easier to switch versions)
  • NodeJS >= 16 required
  • yarn (npm install -g yarn)
  • If you're on Windows, 16 GB of RAM

In a terminal, run:

  • git config --global core.editor "code --wait" - It allows to use GitLens interactive rebase client when running rebases from Git Graph (or from the terminal).
  • corepack enable then corepack prepare yarn@stable --activate to install yarn (explanation)

First usage of git? Also run (replace with your name/email):

git config --global user.email "you@example.com" git config --global user.name "Your Name"

Usage

  • We use a VSCode workspace. With VSCode, Open Workspace from File..., select the file clapy.code-workspace. Don't open the root directory.
  • Required: Install the suggested plugins and accept to use the TypeScript workspace version when prompted.
  • yarn install in the root directory
  • To develop:
    • Build and watch everything: in VS Code: "Run Build Task" command (Ctrl+Shift+B with my keyboard shortcuts) to run the default build task and build everything (1)
    • "Start Debugging" command (F11 with my keyboard shortcuts) to start the debugger for the webservice
  • Alternatively, to develop on the webservice only:
    • yarn dup through command-line to start all docker containers (like docker-compose up -d)
    • "Start Debugging" command (F11 with my keyboard shortcuts) to start the debugger for the webservice

(1) Alternative: yarn dev through command-line to start everything

Build and release

Plugin

Option 1:

  • After a push to the master branch, a github action uploads a zip to publish on AOL's Drive
  • Unzip in [repo-directory]/figma-plugin-clapy/dist, so that the manifest is directly in dist/manifest.json (it could be any directory, as long as it is always the same, but that one is compatible with option 2)
  • Register the plugin on Figma by providing dist/manifest.json (first time only; the next time Figma will remember the plugin)
  • Test
  • Publish new version from the Figma plugin panel

Option 2:

cd figma-plugin-clapy
yarn build:prod
  • It will build the plugin in [repo-directory]/figma-plugin-clapy/dist
  • Register the manifest on Figma (first time only; the next time Figma will remember the plugin)
  • Register the plugin on Figma by providing dist/manifest.json (first time only; the next time Figma will remember the plugin)
  • Test
  • Publish new version from the Figma plugin panel

Apply updates to the database

  • Run hasura console in a terminal, and open the printed link. From the hasura console, make the desired changes.
  • Run yarn gentypes to update the TypeScript interface and graphql model in the code base.

Note: for now, the corresponding Hasura console task is excluded from the default build because it's rarely useful in current developments. If you find yourself often opening the console, don't hesitate to add the task back to the main task, Start dev env, in .vscode/tasks.json.

Updates

Update yarn

  • yarn set version stable
  • yarn dlx @yarnpkg/sdks vscode may be required when upgrading typescript, so that VSCode typescript workspace version is also updated.
  • yarn install in the root (and the back and the front?) directories.

Update libraries

  • yarn upgr and select the new versions.

Special mentions:

  • Hasura CLI: you need to update the library version + the version of the image hasura/graphql-engine in docker-compose.yml + db/Dockerfile. They all have to have the same version number.
  • @types/node: the major version should be the same as the node used in the project

"Code-to-design" libraries (the old Clapy), unused for now:

  • opentype.js: it's a fork, no need to upgrade for now (see Open PR & issues from me below)
  • puppeteer

Update Hasura

See db/README.md

Open pgAdmin

  • Get your database credentials.
  • Locally, yarn dup pgadmin to start pgAdmin, then open its UI from Docker Desktop. Credentials are in .env, variables PGADMIN_DEFAULT_EMAIL and PGADMIN_DEFAULT_PASSWORD.
  • Right-click Servers > Register > Server...
  • Name: whatever you want (e.g. Metabase prod). In Connection tab, fill the hostname, port, maintenancedatabase, username, password.

Troubleshooting

Error: Cannot find module '/app/dist/main2'

Open a docker container terminal and remove /app/node_modules/.cache/tsconfig.tsbuildinfo

rm /app/node_modules/.cache/tsconfig.tsbuildinfo

This must be done inside Docker, because node_modules is in a separate volume.

Switch backend to experiment with a script outside the webservice

To use main2.ts instead of main.ts, open docker-compose.yml and change the backend command to command: yarn start:docker:debug:main2.

WARN: don't commit this change. It's a convenience to make development easier on features testable outside the webservice.

Yarn auto-completion

Suggested package: https://github.com/dsifford/yarn-completion Alternative: https://github.com/mklabs/yarn-completions Discussion: yarnpkg/yarn#609

Open PR & issues from me:

PR: opentypejs/opentype.js#503 Fork: https://github.com/antoineol/opentype.js

VS Code debugger : microsoft/vscode#150036

AST exploration tools

Notes for later

  • If need to hash images, binaries... the lib sha256-uint8array can help. I also tried crypto-js and use sha.js in another context, but they seem bigger/slower.

Figma plugin tips

Notes to help making a Figma plugin:

Faster bundling with vitejs:

Another template for figma plugin using iframe for live reload: https://github.com/PluginFinchy/Figma-Vue3-Template/blob/main/livepreview.html

Repo figma-plugin-helpers by a community member in slack: https://github.com/figma-plugin-helper-functions/figma-plugin-helpers

CSS AST tools

https://github.com/csstree/csstree 20M downloads, 1.4k likes -- good, targetting my use case https://github.com/postcss/postcss 66M downlaods, 26k likes -- has a parser, but too general purpose, probably too big and harder to use. https://github.com/reworkcss/css 12M downloads, 1.4k likes -- seems to focus on read, not write

downloads are weekly figures on npmjs.com.

Inspiration to convert figma config to CSS: https://github.com/figma-plugin-helper-functions/figma-plugin-helpers/blob/master/src/helpers/getCSSStyles.ts

CDN for assets

Uploaded on Cloudinary