Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 5.13 KB

README.md

File metadata and controls

78 lines (48 loc) · 5.13 KB
Raw

Bitcoin Design Guide

This is the repository for the Bitcoin Design Guide, and the bitcoin.design community website.

Discussion and collaboration is taking place in the Bitcoin Design Slack (#bitcoin-design-guide).

The Bitcoin 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. The Bitcoin Design Slack and the bitcoin.design website are the first steps in this direction.

Process and how to contribute

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 the Bitcoin Design Slack, in the #bitcoin-design-guide channel, and here on GitHub in Issues, Pull requests and Discussions. Also see the roadmap for an overview of current and upcoming activities.

You can read more about how to contribute.

Guide Content

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

Origin and history

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 are Version 1 and Version 2 for reference.

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

On February 9, 2022, the community announced the completion of a major revision of the guide to include content about the Lightning network.

How to build and run the site locally

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 with ruby -v). Must be 2.2.5 or higher. Install instructions can be found at https://www.ruby-lang.org/en/documentation/installation/.
  2. If you don't already have Bundler (check with which bundle), you can install by following the instructions at https://bundler.io.

Clone the source code, build, and serve:

  1. Clone this repository and cd into it.
  2. Run bundle install
  3. Run bundle exec jekyll serve
  4. Browse the site at http://127.0.0.1:4000/

To run on gh-pages, uncomment the base_url variable in _config.yml.

baseurl: "bitcoin-design-guide"

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

Docker You can also run site locally with Docker.

  1. Install docker
  2. cd into a directory, for example cd Documents/Guide
  3. Run docker-compose up (you may need to wait for 5-10 minutes)