This repository has been archived by the owner on Dec 19, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into 1_autorelease_on_tag
# Conflicts: # package.json # yarn.lock
- Loading branch information
Showing
76 changed files
with
4,713 additions
and
621 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
<!-- | ||
Hi! | ||
Please use the template below for issue bugs found within cyb. | ||
Provide a general summary of the issue in the title above and use relevant fields below to define the problem. | ||
--> | ||
### Current Behavior | ||
[comment]: # (Describe what actually happened.) | ||
|
||
### Log | ||
[comment]: # (Also you can attach log to this issue.) | ||
|
||
### Expected Behavior | ||
[comment]: # (Describe what you expected to happen.) | ||
|
||
|
||
### Reproduction | ||
[comment]: # (Describe how we can replicate the bug step by step.) | ||
|
||
|
||
### Solution | ||
[comment]: # (Provide a summary of the solution and a task list on what needs to be fixed.) | ||
*Summary*: | ||
|
||
|
||
### Definition of Done | ||
[comment]: # (Any other information that would be useful, bullets are helpful.) | ||
|
||
|
||
### Additional Information | ||
[comment]: # (Any other information that would be useful, content, screenshots, etc.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
<!-- | ||
Hi! | ||
Please use the template below for issue bugs found within cyb. | ||
Provide a general summary of the issue in the title above and use relevant fields below to define the problem. | ||
--> | ||
|
||
### User Story | ||
|
||
[comment]: # (As a <user type>, I want to <task> so that <goal>.) | ||
|
||
|
||
### Why Is this Needed? | ||
|
||
[comment]: # (Describe the problem and why this task is needed. Provide description of the current state, what you would like to happen, and what actually happen) | ||
*Summary*: | ||
|
||
### Solution | ||
[comment]: # (Provide a summary of the solution and a task list on what needs to be fixed.) | ||
*Summary*: | ||
|
||
|
||
### Definition of Done | ||
[comment]: # (Any other information that would be useful, bullets are helpful.) | ||
|
||
|
||
### Additional Information | ||
[comment]: # (Any other information that would be useful, content, screenshots, etc.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
name: Gitcoin issue template | ||
about: This is recommended issue template for gitcoin | ||
|
||
--- | ||
|
||
#### Overview | ||
[Here](https://github.com/cybercongress/cyb/blob/master/README.md) you can explore our project | ||
|
||
--- | ||
#### Current project situation | ||
|
||
Current project situation section where you can explain why we need to solve this task | ||
|
||
--- | ||
#### Task description | ||
|
||
Explain task clearly with details | ||
|
||
--- | ||
#### Required skills | ||
|
||
- List; | ||
- required; | ||
- skills; | ||
- here. | ||
|
||
--- | ||
#### Contribution rules | ||
|
||
[Here](https://github.com/cybercongress/cyb/blob/master/CONTRIBUTION.md) you can learn how to contribute to our project | ||
|
||
--- | ||
#### Definition of done | ||
|
||
Explain what you actually want to see as a result: | ||
- [ ] you can | ||
- [ ] also | ||
- [ ] use checkboxes | ||
|
||
--- | ||
#### Extra information | ||
|
||
Bounty amount | 999 ETH | ||
------------ | ------------- | ||
Experience level | beginner / intermediate / advanced | ||
Project length | hours / days / weeks / mounths | ||
Expires in | 2 weeks / 1 mounth / 3 mounths / 6 mounths / 1 year | ||
Bounty type | bug / feature / security / other |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Pull request template | ||
|
||
Thank you for your contribution. We hope that your work is useful. To avoid extra questions from our side please describe your PR and done checklist. | ||
|
||
## Get in touch | ||
|
||
Before starting to work on a feature or a fix, please **open an issue** to discuss the use case or bug with us. This can save a lot of time for both you and us. For any non-trivial change, we ask you to create a short design document explaining: | ||
|
||
- Why is this change done? What's the use case? | ||
- What will the API looks like? (For new features) | ||
- What test cases should it have? What could go wrong? | ||
- How will it roughly be implemented? (We'll happily provide code pointers to save your time) | ||
|
||
## Link it | ||
|
||
Reference your issue to PR | ||
|
||
## Checklist | ||
|
||
_Put an `x` in the boxes that are applied. You can also fill them out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ | ||
|
||
- [ ] I have opened an issue | ||
- [ ] I have read the [CONTRIBUTING](https://github.com/cybercongress/cyb/blob/master/CONTRIBUTION.md) you can learn how to contribute to our project doc | ||
- [ ] I keep pull requests small so they can be easily reviewed | ||
- [ ] Lint and unit tests pass locally with my changes | ||
- [ ] I have added tests that prove that my fix is effective or my feature works | ||
- [ ] I have added necessary documentation (if appropriate) | ||
- [ ] I have ensured there were no compiler warnings | ||
- [ ] I avoid breaking the continuous integration build | ||
- [ ] I avoid making significant changes to the driver's overall architecture. | ||
- [ ] Any dependent changes have been merged and published in downstream modules | ||
|
||
## Further comments | ||
|
||
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... | ||
|
||
## Getting help | ||
|
||
If you run into any trouble, please reach out to us on the issue you are working on. | ||
|
||
## Our thanks | ||
|
||
We deeply appreciate your effort toward improving Search. For any contribution, large or small, you will be immortalized in the release notes for the version you've contributed to. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,59 @@ | ||
yarn start | ||
|
||
<h1 align="center"> | ||
WEB3 BROWSER | ||
</h1> | ||
|
||
<div align="center"> | ||
<img src="/readme.png"></a> | ||
</div> | ||
|
||
|
||
<div align="center"> | ||
<img src="https://img.shields.io/github/release/cybercongress/cyb.svg?style=flat-square&longCache=true"> | ||
<img src="https://img.shields.io/github/license/cybercongress/cyb.svg?style=flat-square&longCache=true"> | ||
</div> | ||
|
||
|
||
<div align="center"> | ||
<img src="https://img.shields.io/github/contributors/cybercongress/cyb.svg?style=flat-square&longCache=true" alt=""> | ||
<img src="https://img.shields.io/badge/contributions-welcome-orange.svg?style=flat-square&longCache=true" alt="" /> | ||
</div> | ||
|
||
<div align="center"> | ||
<sub>Built by | ||
<a href="https://twitter.com/cyber_devs">cyber•Congress</a> and | ||
<a href="https://github.com/cybercongress/chaingear/graphs/contributors"> | ||
contributors | ||
</a> | ||
</div> | ||
|
||
|
||
## Getting Start Useful Links | ||
|
||
* [Whitepaper](./docs/cyb.md) | ||
* [What is web3](docs/web3-vision.md) | ||
* [App development guidelines](./docs/app-guidelines.md) | ||
|
||
## Issues | ||
|
||
If you have any problems with or questions about CYB, please contact us through a | ||
[GitHub issue](https://github.com/cybercongress/cyb/issues). | ||
|
||
## Gitcoin Tasks | ||
<a href="https://gitcoin.co/explorer?q=cyber-browser"> | ||
<img src="https://gitcoin.co/funding/embed?repo=https://github.com/cybercongress/cyber-browser"> | ||
</a> | ||
|
||
## Contribute | ||
|
||
You are invited to contribute new features, fixes, or updates, large or small; We are always thrilled to receive pull | ||
requests, and do our best to process them as fast as We can. You can find detailed information in our | ||
[contribution guide](./CONTRIBUTION.md). | ||
|
||
## Roadmap & Changelog | ||
|
||
Stay tuned with our [Changelog](./CHANGELOG.md) and [Roadmap](https://github.com/orgs/cybercongress/projects/1). | ||
|
||
## Join Us On Telegram | ||
|
||
If you're interested in using or developing CYB, come [join us on Telegram](https://t.me/fuckgoogle) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# DApp guidelines | ||
|
||
@asadovka | ||
|
||
## What is App? | ||
|
||
App in Cyb is a one or multi page application. It can be a simple html file as a frontend and may include smart contract logic as a backend. Apps should be available through IPFS hash. | ||
|
||
## App structure | ||
|
||
Cyb CLI can automatically generate structure for your App. All you need to do is just type some commands, come up with a name and develop! | ||
|
||
## App requirements | ||
|
||
We set limitations of computation resources usage for each app. | ||
|
||
- less then 5% of CPU usage | ||
- less then 10% of RAM usage | ||
|
||
## App development | ||
|
||
Here we describe how to generate initial app structure. | ||
|
||
1. Install the latest version of CYB package | ||
npm install -g cyb | ||
|
||
2. Select the path where you want to store your app. For example /Desktop/My_apps | ||
cd username/Desktop/My_apps | ||
|
||
3. Enter the name and generate the structure of the app. A folder with all necessary components will be created | ||
cyb init appname | ||
|
||
4. Go to the app folder and link your app with your Cyb | ||
cyb link | ||
|
||
5. Open the Appstore in CYB. You will see your app on «Your app» page | ||
|
||
You can also use our Help App (cyb://.help/create) for more info. | ||
|
||
## App deployment | ||
|
||
When you are ready with development of your app you can easely publish it to the DApp Store so every user of Cyb will see it. | ||
Open your app, click on "deploy" button and enter IPFS hash of your app. Sign the transaction - your app will be registred in Chaingear. And that is it! | ||
|
||
## App design | ||
|
||
App design process follows Web3 design principles. | ||
|
||
## State rules | ||
|
||
We use simple colored states for states of transactions or operations: | ||
|
||
- mempool/failed - red | ||
- confirmed/reverted - yellow | ||
- finalized/succesful - green | ||
|
||
## Data visualization | ||
|
||
Data should be visualised in a simple and attractive way. No overloaded plots an diagrams, we use animation instead. | ||
|
||
## Blockchain objects presenting | ||
|
||
Blockchain data is too complicated and sometimes not obvious for people. Thus we use adaptive tricks to make work process more convenient: | ||
|
||
1. Logical grouping for objects. Every app page has common groups of data (general, blockchain specific) for inheritance of views and better navigation or data observing. | ||
2. Classical accounting terms used for balance and cashflow operations. Blockahains use econimic principles for interaction between subjects thus we can describe such processes in established terms. | ||
3. Robohash logo for contracts entities. Contracts can act by themself, have and algorithms, so it's more natural to perceive them like robots instead of pieces of code. |
Oops, something went wrong.