Use this app starter kit to create a Nimiq-powered app in seconds. It contains all the boilerplate code needed to get you started. Check out the demo.
This app starter kit includes frameworks and components that Nimiq developers commonly use to create Nimiq-enabled web applications.
Have a look at the demo for an overview of the included features. Also check out a simple demo wallet built with the app starter kit in 6 easy to follow steps in the demo-wallet branch.
New to Nimiq? Check out nimiq.com.
Add the app starter kit to your project:
git remote add starter-kit git@github.com:nimiq/app-starter-kit.git
git fetch starter-kitThen merge it into your code base:
git merge --allow-unrelated-histories starter-kit/masterEach commit of the starter kit commit history represents one
feature. If you don't need all features of the app starter kit, you can use
git revert to remove specific commits. Alternatively, you can also
cherry-pick just the specific commits that you need instead of merging.
When reverting or cherry-picking commits, keep in mind that there is a dependency between some of the commits. See the
demo page for more details.
To get started, setup everything and get all dependencies with yarn:
yarn installRun a development server that watches the project files, compiles them on demand and hot-reloads the changes to keep your browser in sync:
yarn serveLint your code:
yarn lintTo automatically fix lint errors:
yarn lint --fixRun your unit tests:
yarn test:unitCompile and minify the project to be ready for deployment in production:
yarn buildPlease feel free to get in touch and send PRs!
Please understand that PRs might be squashed into a single commit on merge to keep the commit history as simple as possible. PR authors will however be attributed authorship / co-authorship of that commit.