Awesome

Note

• 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:

• Table of contents:
  • Installing the Latest Release
  • Developing Locally
    • Pull the code
    • Temporary preliminary steps
      • Enable self-signed local SSL certs
      • Environment variables
    • Install dependencies
    • Build all packages for production
    • Start everything inside ./packages for development
      • Troubleshooting
    • Install the development version of the extension
      • Not seeing the dev folder?
    • Optionally install the built extension
  • License

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.

Developing Locally

https://user-images.githubusercontent.com/101902546/173857300-fc139113-0af5-46fc-baad-236a2ebf63f1.m4p

Pull the code

git clone git@github.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.

Environment variables

Install dependencies

yarn install

You can also optionally rename .env.example to .env and set your own variables.

Build all packages for production

yarn build

Start everything inside ./packages for development

yarn start

Note: In a fresh repo, you should run yarn build before yarn start.

Troubleshooting

If you run into issues with builds try running yarn clean and then start again.

You need to install a SSL certificate for localhost as the one provided by webpack-dev-server is considered invalid. This step is optional as react-refresh will still function without it, but it's a good idea to try and fix this error because otherwise your browser will be making a lot of failed requests and webpack-dev-server might not be functioning to its full capabilities.

A relatively simple way of doing this is using mkcert

Instructions for how to install a trusted self-signed cert on macOS -

cd packages/app-extension
brew install mkcert
mkcert localhost
mkcert -install

Now the next time you run yarn start the errors should no longer appear.

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 node and start over
• Try running yarn start from within packages/app-extension while running yarn start from 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 yarn start

License

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.