twenty/packages/twenty-chrome-extension
Abdullah d14bb2ea11
Add linter to Chrome Extension (#4044). (#4174)
* feat: configure eslint rules by replicating those in the twenty-front package and introduce scripts for linting, formatting code and removing build output

* fix: ensure each file of the extension package satisfies linting rules and disable some rules where necessary

* fix: update relative imports to absolute imports throughout extension code with the defined tilde and at symbols

* fix: import the updated ui module from the front package to the chrome extension package to prevent eslint rules from breaking subject to the recent merged changes into main

* fix: commit the case change for files that were missed by Git in the earlier commits due to default configuration
2024-02-25 17:32:08 +01:00
..
public Closes #2413 - Building a chrome extension for twenty to store person/company data into a workspace. (#3430) 2024-02-12 12:30:23 +01:00
src Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
.env.example Closes #2413 - Building a chrome extension for twenty to store person/company data into a workspace. (#3430) 2024-02-12 12:30:23 +01:00
.eslintrc-ci.cjs Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
.eslintrc.cjs Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
.gitignore Closes #2413 - Building a chrome extension for twenty to store person/company data into a workspace. (#3430) 2024-02-12 12:30:23 +01:00
options.html Closes #2413 - Building a chrome extension for twenty to store person/company data into a workspace. (#3430) 2024-02-12 12:30:23 +01:00
package.json Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
README.md Closes #2413 - Building a chrome extension for twenty to store person/company data into a workspace. (#3430) 2024-02-12 12:30:23 +01:00
tsconfig.app.json Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
tsconfig.json Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
tsconfig.spec.json Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00
vite.config.ts Add linter to Chrome Extension (#4044). (#4174) 2024-02-25 17:32:08 +01:00

Twenty Chrome Extension.

This extension allows you to save company and people information to your twenty workspace directly from LinkedIn.

To install the extension in development mode with hmr (hot module reload), follow these steps.

  • STEP 1: Clone the repository and run yarn install in the root directory.
  • STEP 2: Once the dependencies installation succeeds, create a file with env variables by executing the following command in the root directory.
cp ./packages/twenty-chrome-extension/.env.example ./packages/twenty-chrome-extension/.env
  • STEP 3: Now, execute the following command in the root directory to start up the development server on Port 3002. This will create a dist folder in twenty-chrome-extension.
yarn nx start twenty-chrome-extension
  • STEP 4: Open Google Chrome and head to the extensions page by typing chrome://extensions in the address bar.

  • STEP 5: Turn on the Developer mode from the top-right corner and click Load unpacked.

  • STEP 6: Select the dist folder from twenty-chrome-extension.

  • STEP 7: This opens up the options page, where you must enter your API key.

  • STEP 8: Reload any LinkedIn page that you opened before installing the extension for seamless experience.
  • STEP 9: Visit any individual or company profile on LinkedIn and click the Add to Twenty button to test.

To install the extension in production mode without hmr (hot module reload), replace the command in STEP THREE with yarn nx build twenty-chrome-extension.