- Backpack is in active development, so all APIs are subject to change.
- This code is unaudited. Use at your own risk.
- I repeat. This is not ready for production.
Table of contents:
- Installing the Latest Release
- Developing Locally
Installing the Latest Release
If you'd like to install the latest dev release, grab the latest build.zip here and add it to your local chrome profile, using developer mode. See the video below.
Pull the code
git clone email@example.com:coral-xyz/backpack.git cd backpack
Temporary preliminary steps
Enable self-signed local SSL certs
Go to chrome://flags/#allow-insecure-localhost and enable the toggle, then restart chrome. Note: Please don't enable this if you don't know what you're doing. It will leave you vulnerable to exploits if left on. It is recommended to undo this step when you are done developing.
You can also optionally rename
.env and set your own variables.
Build all packages for production
Start everything inside
./packages for development
Note: In a fresh repo, you should run
yarn build before
If you run into issues with builds try running
yarn clean and then start again.
Install the development version of the extension
Go to chrome://extensions, enable developer mode (top right) and drag the
packages/app-extension/dev dir into the window. This version will have (Dev) in the title and supports live-reloading.
Not seeing the dev folder?
- Do you have a stale node process running? Try to kill it all:
killall -9 nodeand start over
- Try running
yarn startfrom within
yarn startfrom root. This should work.
Optionally install the built extension
If you want to try the production build of the extension, run
yarn build and drag the
packages/app-extension/build dir into chrome://extensions as above. This version won't have hot-reloading and local plugins won't be visible unless you also run
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion by you shall be licensed at the discretion of the repository maintainers without any additional terms or conditions.