Contributing

Like what you see and want help building it out? Find a bug that needs to be squashed? Get in touch, log an issue, submit a PR, or just say hi.

Issues and Requests

We welcome issues, feature requests, pull requests, and any contributions. Handoff is sponsored and developed by Convertiv. You can contact us there, or for a more specific technical discussion, leave an issue at our github account.

Working with the Source Code

If you want to work directly with the source code, you can explore this repo directly. The code is all in typescript, and the project is broadly separated into three parts:

  • Next JS Site generator
  • Figma Exporter and transformers
  • Supporting assets (build, installer, resources)

You must compile from TypeScript when you run the project. The NextJS code has automatic TS compilation, but the Figma exporter must be compiled prior to each run. Here are the main commands you can run:

npm run build:lib

Builds the figma-exporter fetch source code found in figma-exporter.

npm run fetch

Fetch the latest from the Figma project specified in the .env file. The user token must have access to the specified project.

npm run dev

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm run build:static

Builds the app for production to the out folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is ready to be deployed!