twentyhq/twenty
1
1
Fork 0
mirror of https://github.com/twentyhq/twenty.git synced 2024-12-12 11:20:40 +03:00
Code Issues Packages Projects Releases Wiki Activity
464a2d5998
twenty/packages/twenty-chrome-extension/README.md
Abdullah 2a05de5289
Chrome Extension: Update logo and change default routes to those of Twenty prod (#4046). (#4172) 
* fix: replace twenty logo in the png format with one in the svg format for better resolution

* fix: toggle the custom url switch to true if the local storage contains a server base url different from that of the env variable

* fix: update the front base url and the server base url to those of the production environment in the .env.example file

* fix: update README to add a step for changing env variables to those of the development environment for contributors or local testers
2024-02-26 09:05:59 +01:00

2.5 KiB
Raw Blame History

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 (optional): Update values of the environment variables to match those of your instance for twenty-front and twenty-server. If you want to work on your local machine with the default setup from Twenty Docs, replace everything in the .env file with the following.
VITE_SERVER_BASE_URL=http://localhost:3000
VITE_FRONT_BASE_URL=http://localhost:3001
  • STEP 4: 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 5: Open Google Chrome and head to the extensions page by typing chrome://extensions in the address bar.

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

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

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

  • STEP 9: Reload any LinkedIn page that you opened before installing the extension for seamless experience.

  • STEP 10: 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 FOUR with yarn nx build twenty-chrome-extension. You may or may not want to execute STEP THREE based on your requirements.