|
||
---|---|---|
.circleci | ||
.github | ||
.storybook | ||
app | ||
development | ||
docs | ||
mascara | ||
notices | ||
old-ui | ||
test | ||
ui | ||
.babelrc | ||
.dockerignore | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.gitattributes | ||
.gitignore | ||
.nsprc | ||
.nvmrc | ||
.stylelintignore | ||
.stylelintrc | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
Dockerfile | ||
ISSUE_TEMPLATE | ||
LICENSE | ||
MISSION.md | ||
README.md | ||
USER_AGREEMENT.md | ||
colors.js | ||
docker-compose.yml | ||
fonts | ||
gentests.js | ||
gulpfile.js | ||
images | ||
package-lock.json | ||
package.json |
README.md
Nifty Wallet Browser Extension
Introduction
Building locally
- Install Node.js version 10.16.0 and npm version 6.9.0
- If you are using nvm (recommended) running
nvm use
will automatically choose the right node version for you. - Select npm 6.9.0:
npm install -g npm@6.9.0
- If you are using nvm (recommended) running
- Install dependencies:
npm install
- Install gulp globally with
npm install -g gulp-cli
. - Build the project to the
./dist/
folder withgulp build
. - Optionally, to rebuild on file changes, run
gulp dev
. - To package .zip files for distribution, run
gulp zip
, or run the full build & zip withgulp dist
.
Uncompressed builds can be found in /dist
, compressed builds can be found in /builds
once they're built.
Contributing
You can re-generate the docs locally by running npm run doc
, and contributors can update the hosted docs by running npm run publish-docs
.
Running Tests
Requires mocha
installed. Run npm install -g mocha
.
Then just run npm test
.
You can also test with a continuously watching process, via npm run watch
.
You can run the linter by itself with gulp lint
.
Architecture
Development
npm install
npm start
Build for Publishing
npm run dist
Writing Browser Tests
To write tests that will be run in the browser using QUnit, add your test files to test/integration/lib
.
Other Docs
- How to add custom build to Chrome
- How to add custom build to Firefox
- How to develop a live-reloading UI
- How to develop an in-browser mocked UI
- How to live reload on local dependency changes
- How to manage notices that appear when the app starts up
- How to use the TREZOR emulator
- How to generate a visualization of this repository's development