diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5da5d041b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contribution Guidelines + +Thank you for considering contributing to our project! We appreciate any help you can provide. + +## How to Contribute + +1. Fork the repository. +2. Create a new branch for your changes. +3. Make your changes in the new branch. +4. Run the tests to make sure your changes haven't broken anything. +5. If the tests pass, submit a pull request from your new branch to the `develop` branch of the upstream repository. + +Please make sure your pull request adheres to the following guidelines: + +- Make sure your code follows the style guidelines of the project. +- Write tests for your new code, if applicable. +- Make sure the tests pass. +- Follow the project's commit message conventions, [semantic-release](https://github.com/semantic-release/semantic-release#commit-message-format) is used. +- Use a clear and descriptive title for the pull request. +- Provide a detailed description of your changes and why they are necessary. + +## Contact + +If you have any questions or concerns, feel free to reach out to the maintainers of the project at [discord](https://discord.gg/4Jhk3N9N). diff --git a/README.md b/README.md index ecc030c00..f5c08e0ab 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,16 @@ The SSI Snap enables everyone to build their **decentralized and self-sovereign identity by enhancing MetaMask with functionalities to manage DIDs, VCs, and VPs.** Any dApp can connect it to access identity data, and dApp developers can already start with the integration! -[Demo](https://blockchain-lab-um.github.io/course-dapp/) -[Docs](https://blockchain-lab-um.github.io/ssi-snap-docs/) -[Blog post](https://medium.com/@blockchainlabum/open-sourcing-ssi-snap-for-metamask-aaa176775be2) +- [Website](https://blockchain-lab-um.github.io/ssi-snap/) +- [Demo](https://blockchain-lab-um.github.io/course-dapp/) +- [Docs](https://blockchain-lab-um.github.io/ssi-snap-docs/) +- [Blog post](https://medium.com/@blockchainlabum/open-sourcing-ssi-snap-for-metamask-aaa176775be2) # Features The SSI Snap is built agnostic, leaving the user to choose his preferred **blockchain, DID method, and data storage provider.** Everything is configurable, just like selecting the network in MetaMask. Currently supported technologies: -- **Blockchains:** Ethereum +- **Blockchains:** Any EVM-based blockchain that is supported by DID methods - **DID methods:** `did:ethr`, `did:key` - **Data storage providers:** Local (MetaMask Snap state), Ceramic @@ -25,13 +26,22 @@ Many new features are already in the works. For more information, please check t - Node.js `18`. We **strongly** recommend you install via [NVM](https://github.com/creationix/nvm) to avoid incompatibility issues between different node projects. - Once installed, you should also install [Yarn](http://yarnpkg.com/) with `npm i -g yarn` to make working with this repository easiest. -## Installing - ## Running +- Run `yarn build:all` + ### Snap -### Demo +- To start the Snap run `yarn start:snap` +- Snap can be tested on `localhost:8081/` or on SSI Snap Website + +### Website + +- To start the Website run `yarn start:dapp` + +### Docs + +- To start the Website run `yarn start:docs` # Feature requests diff --git a/package.json b/package.json index 7d0277467..c2d46eeaf 100644 --- a/package.json +++ b/package.json @@ -40,6 +40,7 @@ "prepare": "is-ci || husky install", "prettier": "prettier --write .", "start": "yarn nx run-many --target=start --all", + "start:dapp": "yarn nx start @blockchain-lab-um/website", "start:docs": "yarn nx start @blockchain-lab-um/ssi-snap-docs", "start:snap": "yarn nx start @blockchain-lab-um/ssi-snap", "test": "yarn nx affected --target=test",