generated from MetaMask/template-snap-monorepo
-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 changed file
with
2 additions
and
52 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,3 @@ | ||
| # @metamask/template-snap-monorepo | ||
| # Slots Snap | ||
|
|
||
| This repository demonstrates how to develop a snap with TypeScript. For detailed | ||
| instructions, see [the MetaMask documentation](https://docs.metamask.io/guide/snaps.html#serving-a-snap-to-your-local-environment). | ||
|
|
||
| MetaMask Snaps is a system that allows anyone to safely expand the capabilities | ||
| of MetaMask. A _snap_ is a program that we run in an isolated environment that | ||
| can customize the wallet experience. | ||
|
|
||
| ## Snaps is pre-release software | ||
|
|
||
| To interact with (your) Snaps, you will need to install [MetaMask Flask](https://metamask.io/flask/), | ||
| a canary distribution for developers that provides access to upcoming features. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Clone the template-snap repository [using this template](https://github.com/MetaMask/template-snap-monorepo/generate) | ||
| and set up the development environment: | ||
|
|
||
| ```shell | ||
| yarn install && yarn start | ||
| ``` | ||
|
|
||
| ## Cloning | ||
|
|
||
| This repository contains GitHub Actions that you may find useful, see | ||
| `.github/workflows` and [Releasing & Publishing](https://github.com/MetaMask/template-snap-monorepo/edit/main/README.md#releasing--publishing) | ||
| below for more information. | ||
|
|
||
| If you clone or create this repository outside the MetaMask GitHub organization, | ||
| you probably want to run `./scripts/cleanup.sh` to remove some files that will | ||
| not work properly outside the MetaMask GitHub organization. | ||
|
|
||
| If you don't wish to use any of the existing GitHub actions in this repository, | ||
| simply delete the `.github/workflows` directory. | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Testing and Linting | ||
|
|
||
| Run `yarn test` to run the tests once. | ||
|
|
||
| Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and | ||
| fix any automatically fixable issues. | ||
|
|
||
| ### Using NPM packages with scripts | ||
|
|
||
| Scripts are disabled by default for security reasons. If you need to use NPM | ||
| packages with scripts, you can run `yarn allow-scripts auto`, and enable the | ||
| script in the `lavamoat.allowScripts` section of `package.json`. | ||
|
|
||
| See the documentation for [@lavamoat/allow-scripts](https://github.com/LavaMoat/LavaMoat/tree/main/packages/allow-scripts) | ||
| for more information. | ||
| A MetaMask Snap that puts an animated, fully playable Slots game into MetaMask. |