Code Monkey home page Code Monkey logo

btcpayserver.org's Introduction

btcpayserver.org

The official website repository of BTCPay Server project.

Contributing

Feel free to contribute ideas, code or content to improve the website.

Prior to submitting a major pull-request, make sure to discuss the changes with the community on #website channel on Mattermost to avoid duplicating the work.

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.

Please do not open issues not related to the website in this repository. If you have an issue with BTCPay Server software, open an issue in an appropriate repository.

Source files

All changes to the website should be applied in the src folder.

The files in the src are used in conjunction with the transifex/resources to make the btcpayserver.org website.

Create pull requests affecting the CSS, JS, images etc in the src-- and once merged, the changes will be used to roll out updates to the main directory.

Please do not submit any changes to the html files other than those within the src directory.

To fix spelling or grammatical errors, make updates to either the English string(s) in the relevant file of the transifex/resources directory or any of the non-english translations via the Transifex website. If you want to add new strings, append the .json file, preserving the JSON format.

Modifying existing strings may cause the already-translated strings to be lost (more details).

Translating the website

Translations help us make the software relevant for people who need it around the world.

If you would like to help us translate btcpayserver.org, please join the team on Transifex.

Translations are only handled through Transifex, please do not create a pull request for translations.

For more information on contributing by translating, check the translation guides

Translators can opt-in to be notified when new strings require translating for a language they're subscribed to.

We used a 90% minimum threshold for translations.

How to build

Prerequisites:

  • Node.js >= 10
  • Create a .env file containing the API token for Transifex (TRANSIFEX_TOKEN="my_api_token")

Setup:

# Install the dependencies
npm install

# Download the translations – this is mandatory for the rest to work
npm run init

Build:

# Build the site locally and start dev server
npm start

# Build the site for production
npm run prod

btcpayserver.org's People

Contributors

bas02 avatar bitcoinmitchell avatar bolatovumar avatar dennisreimann avatar eskyee avatar jsmith-dev avatar karem-sobhy avatar kukks avatar l33d4n avatar mandelmonkey avatar mariodian avatar marnixcroes avatar ndeet avatar nicolasdorier avatar owldock avatar pavlenex avatar petzsch avatar plmdie avatar radworx avatar riccardomasutti avatar rockstardev avatar satwo avatar tchukwuleta avatar transifex-integration[bot] avatar vswee avatar wbnns avatar woutersamaey avatar zaowens avatar zaxounette avatar zechendorf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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  avatar  avatar  avatar

btcpayserver.org's Issues

Add Telegram, Rename the Wiki

There's BTCPay Telegram that we should add to the Community section.
Furthermore, we should probably only have community group icon in a single row instead of the icon + text.

Also the Wiki should probably be renamed to Discourse.
So:
Slack icon | GitHub icon | Discourse Icon | Telegram Icon

Footer restructure

It seems that our footer on the main website has a bit too much info, and it's not even organized properly imo.

Let's discuss here how we can make it more useful and less cluttered for visitors.

Improve readme

The current readme is outdated. We should improve it.

Website doesn't create invoice matching user selection

Issues when user selects values on the website. The invoice produced doesn't match user selection:

  1. +/- Increment button is used
    Input: User selects donation of $1
    Result: Invoice is $2

  2. Value field is used
    Input: User types in any value
    Result: Invoice is $5

How it works area

Instead of the current area that does not provide useful information, it's been decided that we should display how BTCPay works.

Current area
Capture

Suggested text
How it works

Suggested design on Figma
We probably want to go with minimal design here as there's lots of things going on in above the fold already, so either just a text, or text with numbers 1 2 3 imo. I like the headlines here "Invoice" "Payment" "Wallet" can be clear enough instead of 1 2 3.

Figma

Some languages without code

image

I think it might be better to either add language code for all languages or remove it everywhere. This way it looks strange...

Change demo links

Right now there is an ongoing migration of our demo servers where stores are hosted, so links will be broken and without properly set SSL.

My goal is to improve demos and add :

  • Payment requests demo
  • Crowdfunding demo
  • Improved store demo
  • Improved retail PoS demo

en-json contains legacy strings

We need to clean up en-json since it shows a bunch of legacy strings for people on Transifex. We can't really ask people to translate until we clean it up.

Screenshot 2020-04-17 at 11 39 52

Please add build instructions.

Please document how to build or add a bash script that builds or something. I want to eventually automate builds via Github Actions while also testing my changes locally

Fix text alignment of the wordpress icon

Would be good to remove redundant BTC icons, looks kinda messy. At least on the presta icon the middle one is okay imo.
Screenshot 2020-04-17 at 14 56 52

Also on 13 inch monitor Woocommerce text overlaps the WordPress icon and it does not look that good.
Screenshot 2020-04-17 at 14 49 35

All Letters In Upper Case

The main page text "Start Accepting Bitcoin Payments With 0% Fees & No Third-Party" automatically change first letters to upper case in localized page versions. This might be OK in English but looks very silly for languages like Slovak a I believe many others

UpperCase

Payment button page

We should have a payment button demo page to demonstrate different options of the payment button.

[Mobile] Responsive design issues

Here's a list of known issues happening on mobile. I'll keep them all logged here so we can tackle the one by one.

General Mobile

Empty Menu

Some users reported that the menu looks a bit too empty since it's short & simple.

Screenshot 2020-03-23 at 11 04 41

Dub suggested we enlarge the fonts there to make it look bigger and provided an example of what he did for his work as a solution.

Screenshot 2020-03-23 at 11 12 13

Safari iOS

  • Mobile menu is empty
    2020-03-23_10-59-46 (1)

Determine the text and features in the "Features area"

Right now a suggested features area is decent, but I'd like to see if we can somehow improve it since it seems repetitive with the above the fold content. Lots of info gets repeated often, so perhaps it would be better to push something in features that first-time users can understand and get a better feeling of btcpay possibilities either as a payment processor or a stack.

Current features
features

@vswee made a genius tool https://btcpayserver.flat18.co.uk/loose that allows you to alter text, save it and the share a link with your version for us to preview. It's easier to add text and preview on spot for sure!

Donation Button

Donations plunged since we removed them from the above the fold.
We should probably have Donate button next to the Live Demo.

Change translations to include source strings

Change proposed after switch of the build system in #75:

Currently translations are placed in template files via some array index of a variable (e.g. $j[5] like here:

<a alt="$j[37]" class="promoButton p-1" href="https://mainnet.demo.btcpayserver.org"
                            target="blank_">
                            <span>$j[37]</span><input class="cu_" /></a>

I find this really confusing to read, you always need to check the en translation file en.json and count the lines (starting from 0) to get the correct string, this is tedious when you are not familar with the codebase. I would suggest that we use the EN source string always in those template files with some special placeholder markup like %% (do not care which one).

So above example would look like this:

<a alt="%%here goes the english source text%%" class="promoButton p-1" href="https://mainnet.demo.btcpayserver.org"
                            target="blank_">
                            <span>%%and here is another text%%</span><input class="cu_" /></a>

Another benefit would be that we can extract those strings and generate a en.json and not manually maintain all those translations mappings.

If we agree it makes sense to do it I can give it a shot after the build automation has been merged.

Change favicon

The current favicon is not that good, it should be this one which aligns more with the current design and blog as well.

$5 Donation button creates $1 invoice

I believe it's only on the $5 default button but if the increment buttons are used, it gives the correct value for the invoice.

Thanks Norm for pointing out the issue in Mattermost chat.

Update demo links

I've trashed our old demo site, which will have broken links as a consequence in the next few days, until I came up with better way to showcase the features.

Assigning this to myself to fix. Leaving here as a reminder.

Multilingual support

We should have the main site in different languages. There's not really much to translate. Leaving this here for future and brainstorming.
I guess we should tackle it the same way we tackled other translations, via Transifex.
Tagging our experts @britttttk and @vswee for a brainstorm session.

[New Site] - Make sure we use current invoice & front page design

Once #1405 is merged and we have a final design, we should use that as a demo example. For dark mode (since we won't have it on the server, we can use our own iteration of the dark mode).

Same goes for the front page, by the time we launch the website, we'll have a new server front page so we should use that instead of the one we currently have.

Leaving this as a reminder.

Correction and clarification on English strings

To be corrected

  • "Maximum privacy for you and your customers.Running a full node. No AML/KYC."

  • "Having a technical question not covered in docs or want to help improve the code? Help us out on GitHib."

Suggestion

  • "Bitcoin" shouldn't be capitalized when referring to the token ("They paid me in euros but I'd prefer bitcoins")

Extra text "Lightning network"

There is extra text which is not present in source - looks like this is repro for all languages
image

Everything looks good on Transifex

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.