https://github.com/mattermost-community/mattermost-app-figma
Figma App for Mattermost
https://github.com/mattermost-community/mattermost-app-figma
mattermost mattermost-app
Last synced: 8 months ago
JSON representation
Figma App for Mattermost
- Host: GitHub
- URL: https://github.com/mattermost-community/mattermost-app-figma
- Owner: mattermost-community
- Created: 2023-02-22T08:08:56.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-26T22:03:03.000Z (over 2 years ago)
- Last Synced: 2024-12-30T20:14:47.619Z (9 months ago)
- Topics: mattermost, mattermost-app
- Language: Java
- Homepage:
- Size: 113 KB
- Stars: 2
- Watchers: 26
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Figma App
A Figma app for Mattermost.
### Notes
1. Currently not working due to Figma API problems with webhooks. FILE_COMMENT webhook is not working. Ticket for Figma team is created. Investigation is in progress;
2. Due to API call limit notify file owner logic and preselect team id during subscribe logic should be removed;
### First steps
#### Setting up
1. Run Mattermost server https://github.com/mattermost/mattermost-server/blob/master/README.md
2. Install/Enable Apps plugin https://github.com/mattermost/mattermost-plugin-apps
3. Register a figma app - https://www.figma.com/developers/api#register-oauth2
* as a callback url use - http://MM_INSTANCE__ROOT_URL/plugins/com.mattermost.apps/apps/figma/oauth2/remote/complete
* Copy the client secret for a future step
4. Run Figma integration server app
* Run `docker-compose up` in the root of the Figma App repository
5. In mattermost channel run `/apps install http http://localhost:8080/manifest.json`
#### Link MM account with Figma
1. Run command `/figma configure` and provide client id and client secret from register a figma app step https://www.figma.com/developers/apps
2. Run command `/figma connect` and open link from bot response for linking mm with figma account
### Usage
1. Run command `/figma subscribe` for notifications from figma project or file.
`Note`: For this you will need to provide a team id.
The only way for this it's copy it from Figma url
https://www.figma.com/files/team/{team_id}/{team_name}
Forum topics regarding this:
* https://forum.figma.com/t/suggestion-api-endpoint-for-team-id/3429
* https://spectrum.chat/figma/general/how-to-get-team-id-and-project-id-for-api~191126f9-ec4f-4c4f-9964-766ae2b4916f
2. Run command `/figma list` for subscriptions in current channel
### Building aws bundle
In project root run command `./mvnw clean install -Paws-bundle`
Bundle `figma-aws-bundle.zip` will be inside `target` folder
### Deploy aws bundle with appsctl
https://developers.mattermost.com/integrate/apps/deploy/deploy-aws/
`go run ./cmd/appsctl aws deploy -v figma-aws-bundle.zip`
### Lambda configuration
Increase RAM and timeout ( Lambda -> Configuration -> General Configuration)
Add environmental variable ENCRYPTION_KEY for data encryption in KV ( Lambda-> Configuration -> Environment variables)