For the development environment you need to install these tools:
- .NET Core 3.1 SDK
- Docker: Windows | Mac OS | Linux
To execute tests and run the project for debugging you also need instances of the following running and configured on the right ports:
- NBXplorer
- Postgres
- Bitcoin Core (and optionally other full nodes)
We recommend you use our dockerized setup to bootstrap the development environment: The file BTCPayServer.Tests/docker-compose.yml can be used to spin everything up:
git clone https://github.com/btcpayserver/btcpayserver.git
cd btcpayserver/BTCPayServer.Tests
docker-compose up devTo get started see the README of the test project.
We recommend using Visual Studio Code (cross platform) or Visual Studio 2019 (Windows Only) or Rider (cross platform). You can of course use VIM if you are hardcore, .NET Core is command-line environment friendly.
Visual Studio Code, Visual Studio and Rider will run the debug profile Docker-Regtest. This will run a BTCPayServer instance connecting to the services in your Docker service, so you can easily debug and step through the code.
For more information check out these videos:
- How to contribute to BTCPay Server Development (Windows) by Nicolas Dorier
- Setting up BTCPayServer development environment on Linux (Ubuntu) by RockStarDev
- BTCPay Server Development - Testing pull request, payments (MacOS) by Pavlenex
and these notes:
- How to get started with development by Nicolas Dorier (covering relevant docker commands, paying regtest invoices)