Repository files navigation

This is the repository for theBitcoin Design Guide, and thebitcoin.design community website.

Discussion and collaboration is taking place in theBitcoin Design Discord (#bitcoin-design-guide).

TheBitcoin Design Guide is a free open-source community resource that helps designers, developers and others working on non-custodial bitcoin-products to create better experiences faster. We hope that, over time, it will cover all relevant types of products, including consumer wallets, merchant interactions, exchanges and more. Better products and experiences should ultimately make it more appealing for anyone to own and use bitcoin.

An equally important goal is that the process of creating this guide nurtures an open-source bitcoin design community that can carry this, and other projects forward longer term. TheBitcoin Design Discord and thebitcoin.design website are the first steps in this direction.

The process of creating the guide is meant to be as open and decentralized as possible, resulting in a sustainable model to run projects with the community. Most of the discussion happens in theBitcoin Design Discord, in the #bitcoin-design-guide channel, and here on GitHub inIssues,Pull requests andDiscussions. Also see theroadmap for an overview of current and upcoming activities.

You can read more abouthow to contribute.

The guide is meant to be a simple starting-point for anyone looking to build bitcoin-based applications, while providing deeper topics and value for more experienced bitcoin designers. Bitcoin is the platform, and the guide should provide information and resources that should be consistent across applications built on top of it.

The guide is still being created and should be seen as an evolving resource. Similar to the iterative design process, it starts with core parts then grows in ambition based on community support.

Here is the content that is currently live:

The Bitcoin Design Guide

• Getting started
• Designing bitcoin products
• Daily spending wallet
• Savings wallet
• Upgradeable wallet
• Shared wallet
• How it works
• Resources
• Contribute to guide
• Glossary

The process to create the guide started in the summer of 2020. The first draft outlines of the guide first existed as Google Docs, here areVersion 1 andVersion 2 for reference.

On June 2, 2021, the communityannounced the launch of the initial version of the Bitcoin Design Guide to the public.

On February 9, 2022, the communityannounced the completion of a major revision of the guide to include content about the lightning network.

See theroadmap for what we're currently working on.

You'll want to run the site locally to test your changes.

Make sure you have Ruby and Bundler installed:

1. Check that Ruby is installed (check withruby -v). Must be 2.2.5 or higher. Install instructions can be found athttps://www.ruby-lang.org/en/documentation/installation/.
2. If you don't already have Bundler (check withwhich bundle), you can install by following the instructions athttps://bundler.io.

Clone the source code, build, and serve:

3. Fork this repository and clone itgit clone https://github.com/< your fork of this repository >
4. Change into the cloned directorycd guide
5. Runbundle install
6. Runbundle exec jekyll serve
7. Browse the site athttp://127.0.0.1:4000/

To run on gh-pages, uncomment thebase_url variable in_config.yml.

baseurl: "bitcoin-design-guide"

To test your HTML for errors, run the rake script viarake test.

DockerYou can also run site locally with Docker.

1. Install docker
2. cd into a directory, for examplecd Documents/Guide
3. Rundocker compose up (you may need to wait for 5-10 minutes, usedocker-compose up for older versions of Docker)