diff --git a/.github/BADGES.json b/.github/BADGES.json new file mode 100644 index 0000000..ff5d8fd --- /dev/null +++ b/.github/BADGES.json @@ -0,0 +1,16 @@ +{ + "name": "uiprototype", + "version": "0.0.1", + "description": "Status update badge of UX/UI design", + "progress": "1%", + "repository": { + "type": "git", + "url": "https://github.com/rn54n/bitcoinprivate-website" + }, + "keywords": [ + "bitcoin-private", + "bitcoinprivate" + ], + "author": "rn54n", + "license": "MIT" +} diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..c33d89a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,208 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + + +## Bug reports + +A bug is a _demonstrable problem_ that is caused by the code in the repository. +Good bug reports are extremely helpful - thank you! + +Guidelines for bug reports: + +1. **Use the GitHub issue search** — check if the issue has already been + reported. + +2. **Check if the issue has been fixed** — try to reproduce it using the + latest `master` or development branch in the repository. + +3. **Isolate the problem** — ideally create a [reduced test + case](https://css-tricks.com/reduced-test-cases/) and a live example. + +A good bug report shouldn't leave others needing to chase you up for more +information. Please try to be as detailed as possible in your report. What is +your environment? What steps will reproduce the issue? What browser(s) and OS +experience the problem? What would you expect to be the outcome? All these +details will help people to fix any potential bugs. + +Example: + +> Short and descriptive example bug report title +> +> A summary of the issue and the browser/OS environment in which it occurs. If +> suitable, include the steps required to reproduce the bug. +> +> 1. This is the first step +> 2. This is the second step +> 3. Further steps, etc. +> +> `` - a link to the reduced test case +> +> Any other information you want to share that is relevant to the issue being +> reported. This might include the lines of code that you have identified as +> causing the bug, and potential solutions (and your opinions on their +> merits). + + +## Feature requests + +We are focusing right now on a stable, simple and static website. Features are welcome but +we need to find out whether your idea fits with the scope and aims of the project. +It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. +Please provide as much detail and context as possible. + + +## Pull requests + +Patches, improvements, new features - will help us. Remain focused in scope and avoid unrelated +commits. + +**Please ask first** before embarking on any significant pull request (e.g. +implementing features, refactoring code, porting to a different language), +otherwise you risk spending a lot of time working on something that the +project's developers might not want to merge into the project. + +Please adhere to the coding conventions used throughout a project (indentation, +accurate comments, etc.) and any other requirements (such as test coverage). + +Adhering to the following process is the best way to get your work +included in the project: + +1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your + fork, and configure the remotes: + + ```bash + # Clone your fork of the repo into the current directory + git clone https://github.com//bitcoinprivate-website.git + # Navigate to the newly cloned directory + cd bitcoinprivate-website + # Assign the original repo to a remote called "upstream" + git remote add upstream https://github.com/BTCPrivate/bitcoinprivate-website.git + ``` + +2. If you cloned a while ago, get the latest changes from upstream: + + ```bash + git checkout master + git pull upstream master + ``` + +3. Create a new topic branch (off the main project development branch) to + contain your feature, change, or fix: + + ```bash + git checkout -b + ``` + +4. Commit your changes in logical chunks. Please adhere to these [git commit + message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) + or your code is unlikely be merged into the main project. Use Git's + [interactive rebase](https://help.github.com/articles/about-git-rebase/) + feature to tidy up your commits before making them public. + +5. Locally merge (or rebase) the upstream development branch into your topic branch: + + ```bash + git pull [--rebase] upstream master + ``` + +6. Push your topic branch up to your fork: + + ```bash + git push origin + ``` + +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) + with a clear title and description. + +**IMPORTANT**: By submitting a patch, you agree to allow the project +owners to license your work under the terms of the [MIT License](LICENSE.txt). + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/btcp_mockup_2.jpg b/.github/btcp_mockup_2.jpg new file mode 100644 index 0000000..3957b3d Binary files /dev/null and b/.github/btcp_mockup_2.jpg differ diff --git a/.github/btcp_mockup_2__720x531.jpg b/.github/btcp_mockup_2__720x531.jpg new file mode 100644 index 0000000..048d858 Binary files /dev/null and b/.github/btcp_mockup_2__720x531.jpg differ diff --git a/.github/btcp_prototype_v1.jpg b/.github/btcp_prototype_v1.jpg new file mode 100644 index 0000000..a707c74 Binary files /dev/null and b/.github/btcp_prototype_v1.jpg differ diff --git a/.github/mockup 2.jpg b/.github/mockup 2.jpg new file mode 100644 index 0000000..3957b3d Binary files /dev/null and b/.github/mockup 2.jpg differ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..4f9c9b3 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 BitcoinPrivate + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index f6b8de3..b9694ed 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,64 @@ -# bitcoinprivate-website -new repo for redesigned website +# [BitcoinPrivate Website](https://btcprivate.org/) +[![LICENSE](https://img.shields.io/github/license/rn54n/bitcoinprivate-website)](bitcoinprivate-website/blob/main/LICENSE.txt) +[![WEBSITE](https://img.shields.io/website?url=https%3A%2F%2Fbtcprivate.org)](https://img.shields.io/website?url=https%3A%2F%2Fbtcprivate.org) +[![UIPROTO](https://img.shields.io/badge/dynamic/json?color=blue&label=UI%20prototype%20dev&query=progress&url=https%3A%2F%2Fraw.githubusercontent.com%2Frn54n%2Fbitcoinprivate-website%2Fmain%2F.github%2FBADGES.json)](https://github.com/BTCPrivate/bitcoinprivate-website) +[![TWITTER](https://img.shields.io/twitter/follow/btcpnews?style=social)](https://img.shields.io/twitter/follow/btcpnews?style=social) + +BitcoinPrivate Website is a front-end for the upcoming relaunch of BitcoinPrivate coin. Development on a new chain is in progress and a snapshot happend at 680,000 more informations for $BTCP holders can be checked on [discord](https://discord.gg/2Q2rRjpEzr). + +* Homepage: [https://btcprivate.org](https://btcprivate.org/) +* Origin-Source: [https://github.com/BTCPrivate/bitcoinprivate-website](https://github.com/BTCPrivate/bitcoinprivate-website) +* Twitter: [@bitcoinprivate](https://twitter.com/bitcoinprivate) +* Twitter: [@btcpnews](https://twitter.com/btcpnews) + +## Quick start + +The following should be considered: + +* HTML5, CSS, JavaScript, Bootstrap 4 only +* Simple design and structure +* Static website, no dynamic changing content needed +* Max. two clicks until information displayed +* Clone the git repo — `git clone + https://github.com/BTCPrivate/bitcoinprivate-website.git` - and checkout the + [tagged release](https://github.com/rn54n/bitcoinprivate-website/releases) + you'd like to use. The `dist` folder represents the latest version of the + project for end users. + +## Browser support + +* Chrome *(latest 2)* +* Edge *(latest 2)* +* Firefox *(latest 2)* +* Internet Explorer 11 +* Opera *(latest 2)* +* Safari *(latest 2)* + +*This doesn't mean that BitcoinPrivate Website cannot be used in older browsers, +we'll ensure compatibility with the ones mentioned above.* + +Legacy browser will not be supported. IE8/IE9/IE10 + +## UI / UX design + +A UI/UX design is in progress, after the validation of the UI/UX design we can start coding. An example how it can look like is below: + +![UI/UX Prototype](.github/btcp_prototype_v1.jpg?raw=true "BTCP UI/UX design prototype") +![UI/UX Prototype](.github/btcp_mockup_2__720x531.jpg?raw=true "BTCP UI/UX mockup 2") + +## Documentation + +Right now there is no need for a documentation of the website itself. + +## Contributing + +Anyone is welcome to [contribute](.github/CONTRIBUTING.md), however, if you decide to get +involved, please take a moment to review the [guidelines](.github/CONTRIBUTING.md): + +* [Bug reports](.github/CONTRIBUTING.md#bugs) +* [Feature requests](.github/CONTRIBUTING.md#features) +* [Pull requests](.github/CONTRIBUTING.md#pull-requests) + +## License + +The code is available under the [MIT license](LICENSE.txt). diff --git a/src/favicon.ico b/src/favicon.ico new file mode 100644 index 0000000..fb20ca2 Binary files /dev/null and b/src/favicon.ico differ diff --git a/src/robots.txt b/src/robots.txt new file mode 100644 index 0000000..d0e5f1b --- /dev/null +++ b/src/robots.txt @@ -0,0 +1,5 @@ +# www.robotstxt.org/ + +# Allow crawling of all content +User-agent: * +Disallow: