{"id":19370267,"url":"https://github.com/bitcoindevkit/book-of-bdk","last_synced_at":"2025-02-24T14:23:03.069Z","repository":{"id":104287854,"uuid":"603534625","full_name":"bitcoindevkit/book-of-bdk","owner":"bitcoindevkit","description":"Building a BDK walkthrough style book","archived":false,"fork":false,"pushed_at":"2024-10-21T21:36:06.000Z","size":895,"stargazers_count":23,"open_issues_count":12,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-22T08:42:40.170Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://bitcoindevkit.github.io/book-of-bdk/","language":"Just","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitcoindevkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-18T20:01:12.000Z","updated_at":"2024-10-21T21:35:49.000Z","dependencies_parsed_at":"2024-01-13T03:52:33.760Z","dependency_job_id":"f81dbedf-6a13-4f09-93ad-b20a3a0d158b","html_url":"https://github.com/bitcoindevkit/book-of-bdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoindevkit%2Fbook-of-bdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoindevkit%2Fbook-of-bdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoindevkit%2Fbook-of-bdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoindevkit%2Fbook-of-bdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitcoindevkit","download_url":"https://codeload.github.com/bitcoindevkit/book-of-bdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240492276,"owners_count":19810060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T08:14:46.734Z","updated_at":"2025-02-24T14:23:03.064Z","avatar_url":"https://github.com/bitcoindevkit.png","language":"Just","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Book of BDK\n\nThis repository hosts the code and content for the [Book of BDK website](https://bitcoindevkit.github.io/book-of-bdk/).\nWe use [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material) to render the website and the content.\n\n## Develop locally\n\nTo develop locally, you'll need to install `mkdocs-material`:\n\nFirst you'll likely want to open a python virtual environment (since python environment management can be truly nightmarish otherwise). Doing so will depend on your OS.\n\nHere's an example using [venv](https://docs.python.org/3/library/venv.html) on MacOS. Set up a virtual environment if you don't already have one:\n```shell\nmkdir ~/.venv\npython3 -m venv ~/.venv\n```\nThen start the virtual environemnt:\n```shell\nsource ~/.venv/bin/activate\n```\n\nThen you're ready to install:\n\n```shell\npip install mkdocs-material\n```\n\nYou can serve the site with [`just`](https://just.systems/man/en/):\n\n```shell\njust serve\n```\n\nAll the rust code can be compiled with:\n\n```shell\njust rust\n```\n\nNOTE: Some tests need additional dependencies on macOS such as `libiconv`.\n\nA [Nix](https://nixos.org) shell can be instantiated with:\n\n```nix\nwith import \u003cnixpkgs\u003e { };\nmkShell {\n  nativeBuildInputs = [\n    bashInteractive\n    python311Packages.mkdocs-material\n    # macOS specifics\n    libiconv\n    darwin.apple_sdk.frameworks.Security\n    darwin.apple_sdk.frameworks.SystemConfiguration\n  ];\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitcoindevkit%2Fbook-of-bdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitcoindevkit%2Fbook-of-bdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitcoindevkit%2Fbook-of-bdk/lists"}