Prerequisites: Git, PNPM, and a browser

Building the app

Follow these steps to build Flowtide from source on your system:

Step 1: Clone the repository with Git:

Step 2: Install the packages with PNPM:

pnpm install

Step 3: Build the app:

Check the apps/new-tab/dist folder for the app.

Running the code on Chrome

Once you have completed your build, go to chrome://extensions in your Chromium-based browser and select “Load unpacked”. Select the dist folder and you’re done. Open a new tab to see the result.

Developer mode must be enabled for “Load unpacked” to work

Running the code on Firefox

Once you have completed your Firefox build, zip up the dist folder. Once done, go to about:addons in your Gecko-based browser. Select “Install Add-on from file…” and select the ZIP archive. You should be done. Open a new tab to see the result.

Contributing

Head on over to our GitHub repository and fork it. Clone the repo on your local machine and start developing.

pnpm install && pnpm dev

This will open the web version which is a version without the permissions of Chrome so bookmarks and other functionality exclusive to browser APIs will not work. If you need to test a new feature that requires those, follow the steps to Build the app.

Go to the URL it shows and start developing the app. Once you are done making your changing, push them to GitHub, and file a pull request.