-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
27 additions
and
27 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
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 |
---|---|---|
|
@@ -35,47 +35,47 @@ git clone [email protected]:witnet/sheikah.git | |
cd sheikah | ||
|
||
# install application dependencies | ||
yarn | ||
pnpm install | ||
|
||
# launch development application | ||
yarn electron:serve:wallet | ||
pnpm dev | ||
``` | ||
|
||
### Formatter | ||
|
||
- Verify files are correctly formatted with `yarn lint` | ||
- Repair lint errors with (**this operation modifies your files!**) `yarn lint!` | ||
- Verify files are correctly formatted with `pnpm lint:check` | ||
- Repair lint errors with (**this operation modifies your files!**) `pnpm lint` | ||
|
||
### Test | ||
|
||
We use [Jest](https://facebook.github.io/jest/) for testing. | ||
|
||
```bash | ||
# run unit tests | ||
yarn test | ||
pnpm test | ||
``` | ||
|
||
### Build | ||
|
||
#### Production | ||
|
||
To build the application run: `yarn electron:build`, the build files are written to `dist_electron` directory. | ||
To build the application run: `pnpm build`, the build files are written to `dist_electron` directory. | ||
|
||
### Contributing | ||
|
||
You can read the [contributing guide](https://github.com/witnet/sheikah/blob/master/.github/CONTRIBUTING.md) | ||
|
||
#### Github Actions (continuous integration) | ||
|
||
When opening a pull request a job in [Github Actions](https://github.com/features/actions) will be fired off to check the changes. To avoid wasting time waiting for Github Actions output we provide the command `yarn ci` that will perform almost the same checks but it'll run in your computer. | ||
When opening a pull request a job in [Github Actions](https://github.com/features/actions) will be fired off to check the changes. To avoid wasting time waiting for Github Actions output we provide the command `pnpm ci` that will perform almost the same checks but it'll run in your computer. | ||
|
||
#### Troubleshooting | ||
|
||
- Use `yarn clean` to remove the contents of the build directory (`dist_electron`) | ||
- Use `yarn clean-deps` to remove all installed dependencies | ||
- Use `yarn reinstall` to remove all installed dependencies and install them again | ||
- Use `pnpm clean` to remove the contents of the build directory (`dist_electron`) | ||
- Use `pnpm clean-deps` to remove all installed dependencies | ||
- Use `pnpm reinstall` to remove all installed dependencies and install them again | ||
|
||
If the application doesn't boot correctly and no error is reported in the terminal, try running `yarn reinstall` and try again. | ||
If the application doesn't boot correctly and no error is reported in the terminal, try running `pnpm reinstall` and try again. | ||
|
||
## Release | ||
|
||
|
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 |
---|---|---|
@@ -1,9 +1,9 @@ | ||
module.exports = { | ||
'*.js': ['yarn lint:eslint', 'yarn lint:prettier'], | ||
'*.js': ['pnpm lint:eslint', 'pnpm lint:prettier'], | ||
'{!(package)*.json,.!(browserslist)*rc}': [ | ||
'yarn lint:prettier --parser json', | ||
'pnpm lint:prettier --parser json', | ||
], | ||
'package.json': ['yarn lint:prettier'], | ||
'*.vue': ['yarn lint:eslint', 'yarn lint:stylelint', 'yarn lint:prettier'], | ||
'*.scss': ['yarn lint:stylelint', 'yarn lint:prettier'], | ||
'package.json': ['pnpm lint:prettier'], | ||
'*.vue': ['pnpm lint:eslint', 'pnpm lint:stylelint', 'pnpm lint:prettier'], | ||
'*.scss': ['pnpm lint:stylelint', 'pnpm lint:prettier'], | ||
} |
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