-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): updated project root readme
Signed-off-by: Sedhu <[email protected]>
- Loading branch information
Showing
36 changed files
with
175 additions
and
0 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,89 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, 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. You may merge the Pull Request in once you have the sign-off of the owner, or if you | ||
do not have permission to do that, you may request the reviewer to merge it for you. | ||
|
||
## 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. 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/ |
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,86 @@ | ||
|
||
 | ||
|
||
|
||
# VMWare Blockchain Samples | ||
|
||
VMware Blockchain is an enterprise-grade blockchain platform that enables multi-party workflows. It uses advanced techniques such as byzantine fault-tolerant state machine replication, authenticated data structures, and integration with smart contract execution engines to enable customers to build and run decentralized multi-party applications. | ||
|
||
|
||
This repo contains multiple sample examples which will help in bootstapping. | ||
|
||
|
||
|
||
## Documentation | ||
|
||
[Product Documentation](https://docs.vmware.com/en/VMware-Blockchain) | ||
|
||
### Samples | ||
|
||
Refer to `README.md` inside sample directory for detailed description. | ||
|
||
| Directory | Description | | ||
|-----------|-------------| | ||
| [Artemis](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/artemis) | Sample NFT Platform with ERC 721 Standards| | ||
| [Asset Transfer](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/asset-transfer) | DApp with asset transfer sample| | ||
| [Token Swap](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/erc20-swap) | ERC-20 Token Creation and Swap with React Sample | | ||
| [Token Deploy](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/hardhat) | Deploying ERC 20 Token using Hardhat | | ||
| [Ocen Bound Plastics](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/obp) | Supply Chain Sample Smart Contract with Solidity and Truffle| | ||
| [Supply Chain With](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/on-chain-privacy) | Supply Chain example with On-Chain Privacy | | ||
| [Web3 Python](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/simple-examples)| Sample App on Python using Web3 | | ||
| [Supply Chain DApp](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/supply-chain)| Extensive Supply Chain DApp Sample | | ||
| [Truffle Sample](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/truffle) | Basic Truffle Contract Migration Sample | | ||
| [Load Testing](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/erc20-load-test-tool) | A Sample Load Testing Tool with ERC 20 Token and Web3js| | ||
|
||
#### Util | ||
[Util Scripts](https://github.com/vmware-samples/vmware-blockchain-samples/tree/master/tools) Scripts to aid in development | ||
|
||
|
||
|
||
## Tech Stack | ||
|
||
**Client:** React, etherjs, web3js | ||
|
||
**Server:** Node, NPM, Java, Maven, Spring, | ||
|
||
**Blockchain:** Solidity, Hardhat, Truffle | ||
|
||
**Infra:** Docker | ||
|
||
|
||
## Contributing | ||
|
||
Contributions are always welcome! | ||
|
||
See `contributing.md` for ways to get started. | ||
|
||
Please adhere to this project's `code of conduct`. | ||
|
||
|
||
## FAQ | ||
|
||
## Authors | ||
|
||
- [@ramkri123](https://github.com/ramkri123) | ||
- [@dparmar](https://github.com/dparmar) | ||
|
||
## Contributors | ||
|
||
- [@MRHarrison](https://github.com/MRHarrison) | ||
- [@pengluhyd](https://github.com/pengluhyd) | ||
- [@rkischuk](https://github.com/rkischuk) | ||
- [@robem](https://github.com/robem) | ||
- [@teoparvanov](https://github.com/teoparvanov) | ||
- [@tompscanlan](https://github.com/tompscanlan) | ||
- [@sedhuait](https://github.com/sedhuait) | ||
- [@NickSneo](https://github.com/NickSneo) | ||
|
||
## License | ||
|
||
[MIT](https://choosealicense.com/licenses/mit/) | ||
|
||
|
||
## Feedback | ||
|
||
If you have any issues | feedback | suggestions, [please raise a ticket](https://github.com/vmware-samples/vmware-blockchain-samples/issues) | ||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.