https://github.com/web3/web3.js-plugin-template
Template repo to develop web3.js plugin
https://github.com/web3/web3.js-plugin-template
Last synced: 8 months ago
JSON representation
Template repo to develop web3.js plugin
- Host: GitHub
- URL: https://github.com/web3/web3.js-plugin-template
- Owner: web3
- License: mit
- Created: 2023-08-09T08:39:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T23:23:20.000Z (over 1 year ago)
- Last Synced: 2025-04-23T00:36:14.203Z (8 months ago)
- Language: TypeScript
- Size: 472 KB
- Stars: 8
- Watchers: 5
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
web3-plugin-template
===========
This is a template for creating a repository for web3.js plugin.
How to use
------------
1. Create your project out of this template.
You can do so by pressing on `Use this template` on the above right corner and then select `Create new Repositor`. Please, use the convention `web3-plugin-` for your repo name.
2. Update the `name` and `description` fileds at your `package.json`.
Chose a name like: `@/web3-plugin-` (or the less better `web3-plugin-`).
3. Update the code inside `src` folder.
4. Modify and add tests inside `test` folder.
5. Publish to the npm registry.
You can publish with something like: `yarn build && npm publish --access public`.
Contributing
------------
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
-------
[MIT](https://choosealicense.com/licenses/mit/)