Code Monkey home page Code Monkey logo

btcpayserver-design's Introduction

BTCPay Server

BTCPay Server

Accept Bitcoin payments โ‚ฟ

BTCPay Server is a free and open-source Bitcoin payment processor which allows you to accept bitcoin without fees or intermediaries.

"This is lies, my trust in you is broken, I will make you obsolete" ๐Ÿ’š

View Demo ยท Report a bug ยท Request a feature ยท FAQ

๐Ÿ’ผ Table of Contents

๐ŸŽจ Features

  • Direct, peer-to-peer Bitcoin payments
  • No transaction fees (other than the network fee)
  • No fees, middleman or KYC
  • Non-custodial (complete control over the private key)
  • Enhanced privacy & security
  • Self-hosted
  • SegWit support
  • Lightning Network support (LND, Core Lightning (CLN), Eclair)
  • Tor support
  • Share your instance with friends (multi-tenant)
  • Invoice management and Payment requests
  • Apps: Point of sale, crowdfunding, donation button
  • Full-node reliant wallet with hardware wallet integration and SegWit support
  • Bitcoin-only build, separate community-maintained altcoin build (supported altcoins)

๐Ÿš€ Getting Started

Firstly, decide if you want to host an instance yourself or use a third-party host. If you've chosen to self-host, there are plenty of documented ways to deploy BTCPay Server.

After successful deployment, make sure to check our getting started and walkthrough guides. In case you would like to use Lightning Network, see Lightning guide.

๐Ÿ“— Documentation

Please check out our official website, complete documentation and FAQ for more details.

If you have trouble using BTCPay Server, consider joining communities listed on the official website to get help from other contributors. Only create a GitHub issue for technical issues you can't resolve through other channels or feature requests you've validated with other members of the community.

๐Ÿค Contributing

BTCPay Server is built and maintained entirely by volunteer contributors around the internet. We welcome and appreciate new contributions.

If you're a developer looking to help, but you're not sure where to begin, check the good first issue label, which contains small pieces of work that have been specifically flagged as being friendly to new contributors.

Contributors looking to do something a bit more challenging, before opening a pull request, please join our community chat or start a GitHub discussion to get early feedback, discuss the best ways to tackle the problem, and ensure there is no work duplication.

There are many other ways to get involved with the project. Check our contribution guidelines. To get the big-picture of the project development, visit our evolving roadmap.

๐Ÿง‘โ€๐Ÿ’ป Developing

To begin developing locally, visit our local development guide. There are also several video-tutorials:

How to build

While the documentation advises using docker-compose, you may want to build BTCPay Server yourself.

First, install .NET SDK v8.0 as specified by the Microsoft website.

On Powershell:

.\build.ps1

On linux:

./build.sh

How to run

Use the run scripts to run BTCPay Server, this example shows how to print the available command-line arguments of BTCPay Server.

On Powershell:

.\run.ps1 --help

On linux:

./run.sh --help

How to debug

If you want to debug, use Jetbrain's Rider or Visual Studio 2022.

You need to run the development time docker-compose as described in the test guide.

You can then run the debugger by using the Launch Profile Docker-Regtest.

If you need to debug ledger wallet interaction, install the development time certificate with:

# Install development time certificate in the trust store
dotnet dev-certs https --trust

Then use the Docker-Regtest-https debug profile.

Other dependencies

For more information, see the documentation: How to deploy a BTCPay Server instance.

๐Ÿงช API

BTCPay Server has two APIs:

The Greenfield API is our brand-new API which is still in development. Once complete, it will allow you to run BTCPay Server headlessly. The Legacy API, is fully compatible with BitPay's API. It has limited features, but allows instant migration from BitPay.

๐Ÿ’š Community

Our community is the โค๏ธ of the project. To chat with other community members in real-time, join our Mattermost chat. We're also on GitHub discussions.

๐Ÿ“ License

BTCPay Server software, logo and designs are provided under MIT License.

๐Ÿ™ Supporters

The BTCPay Server Project is proudly supported by these entities through the BTCPay Server Foundation.

Spiral OpenSats Baillie Gifford Tether Human Rights Foundation Strike LunaNode Wallet of Satoshi Coincards IVPN

If you'd like to support the project, please visit the donation page.

btcpayserver-design's People

Contributors

benalleng avatar dennisreimann avatar dstrukt avatar nicolasdorier avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

btcpayserver-design's Issues

Improve Alerts

Before:
Screen Shot 2022-06-12 at 3 16 59 PM

After:
Screen Shot 2022-06-12 at 3 16 04 PM

Proposed Changes:

From 1rem to 0.75rem.

.alert { padding: 0.75rem 1rem; }

From 1.5rem to 1rem.

.alert-dismissible .btn-close { padding: 1rem; }

Remove drop shadow on input component

Realized we wanted to add it to help distinguish the background, but it doesn't apply to the whole element if there's additional text, etc.. and I think we should probably just remove it. Was noticing this more as I audited all of the settings elements.

Clean up and consolidate Figma design system file

Needs more love, and realizing there are quite a few things I've not done in keeping it up to date with the introduction of the Directory work, etc..

Going to spend some time making sure it's easier for other designers to pick up everything they'd need to keep things consistent.

Add more custom spacer utility classes

/* Custom space utils, as Bootstrap has a different spacing scale for > M */
.pt-l { padding-top: var(--btcpay-space-l); }
.pt-xl { padding-top: var(--btcpay-space-xl); }
.pb-l { padding-bottom: var(--btcpay-space-l); }
.pb-xl { padding-bottom: var(--btcpay-space-xl); }
.mt-l { margin-top: var(--btcpay-space-l); }  
.mt-xl { margin-top: var(--btcpay-space-xl); }
.mb-l { margin-bottom: var(--btcpay-space-l); }
.mb-xl { margin-bottom: var(--btcpay-space-xl); }

We should add one for (M)edium as well.

Improve Table View Component

[TODO: post mocks]

  • Improve table header styling; selected and unselected columns
  • Main table action styling... From Action - Action - Action TO More + carot

Improve Calendar Date Selector Component

Current:
Screen Shot 2022-01-24 at 11 33 56 PM

If it's too much work to adjust the component to not have the secondary background behind the icon, as our other similar inputs have that, we can leave for now until we can address that styling.

However, it'd be nice to have the background color match the other input forms, as well as the icon switch when filled.

Mock:
Screen Shot 2022-03-10 at 6 37 25 PM

Add Drop-Shadow to Input & Select Forms

See (#14) "Low" variant.

Could probably implement the same color on Dark Mode, don't want to invert the shadow, would look strange.

Debating if I should apply this to some of the other components as well, so this implementation could wait.

Example of implementation:
Screen Shot 2022-01-27 at 12 34 43 AM

Improve `text-only` buttons hover state

  • Text-only button rounded border radius background on hover (will post examples)

We can leverage whatever the padding we currently have for the button sizes, but this is just a visual example.

Screen Shot 2022-03-10 at 5 57 04 PM

Improve Currency Selector

Not 100% where the best place for this would be, so we can move to the main repo if we need to, but would be great to make this consistent with the other dropdown/select components.

Not a high priority, just flagging.

Screen Shot 2022-04-07 at 10 19 27 PM

Improve checkbox component

  • Increase checkbox size & states

Still debating if I want the checkbox to sit vertically at the top or in the middle (like the switch component), a minor tweak we could decided upon when implementing ... but regardless.

Screen Shot 2022-03-10 at 5 35 12 PM

Drop-Shadow Variation Support

The use cases are listed above, but that can be done at a later date, just getting these 4 variants added would be a good start.

Screen Shot 2022-03-10 at 6 49 09 PM

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.