BTC Map website

Getting started

1. git clone the repo and cd into the directory
2. run yarn to install the packages
3. yarn dev will open the app on localhost:5173
4. after making edits run yarn format to format the files
5. run yarn lint before commiting any changes

Build project

1. Create .env
   Copy .env.example and save as .env
2. yarn build

NOTE: BTC Map uses the latest LTS version of node. If you have NVM, you can simply run nvm use in the root directory of the repo to switch to the supported node version.

Icons

• Iconify: for general material icons
• vite-plugin-icons-spritesheet: for individual icons (i.e. apps) spritesheets are automatically generated
  During development the spritsheets might not update. Use a private-tab to check the latest version.

E2E tests

  yarn playwright test
    Runs the end-to-end tests.

  yarn playwright test --ui
    Starts the interactive UI mode.

  yarn playwright test --project=chromium
    Runs the tests only on Desktop Chrome.

  yarn playwright test example
    Runs the tests in a specific file.

  yarn playwright test --debug
    Runs the tests in debug mode.

PWA

This website is a progressive web app, meaning you can install it on your mobile device and use it like a native application. Just look for the Add to home screen or Install option in your browser while visiting btcmap.org.

Embedding

For information on how to embed the BTC Map web map onto your own website or application please reference our Wiki.

---

Attributions

Thanks to:

Base map tiles

• OpenFreeMap
• OpenStreetMap

Icons

Tagger profile badges by AndrejCibik

Satoshi nakamoto icons created by Vitaly Gorbachev - Flaticon

---