@@ -40,8 +40,7 @@ $ yarn install
40
40
```
41
41
42
42
The installation process will fetch toplevel NPM dependences and build
43
- the ` minter-ui-dev ` and ` minter-api-dev ` Docker images. Subsequent runs of
44
- ` yarn install ` will rebuild these images without checking for cached versions.
43
+ the ` minter-ui-dev ` and ` minter-api-dev ` Docker images.
45
44
46
45
### Configuration
47
46
@@ -89,16 +88,16 @@ administrator during contract origination:
89
88
` ` `
90
89
91
90
> **Note:** Since sandbox keys don't represent sensitive accounts, the ` config /`
92
- > folder includes default configurations with ` admin ` wallets. To configure Minter
93
- > for the ` testnet ` or ` mainnet ` networks, update the definitions in
91
+ > folder includes default configurations with ` admin ` wallets. To configure
92
+ > OpenMinter for the ` testnet ` or ` mainnet ` networks, update the definitions in
94
93
> ` config /minter .<network >.example .json ` and copy it to the proper path for the
95
- > application to read it. For:
94
+ > application to read it. For example :
96
95
>
97
96
> ` cp config /minter .mainnet .example .json config /minter .mainnet .json `
98
97
99
- If the ` contracts ` key or its children ` nftFaucet ` or ` nftFactory ` keys are not
100
- specified, these contracts will be originated and their addresses saved in the
101
- configuration file when starting the Minter devleopment environment.
98
+ If the ` contracts ` key or its child ` nftFaucet ` keys is not specified, a new
99
+ contract will be originated and its addresses saved in the configuration file
100
+ when starting the OpenMinter development environment.
102
101
103
102
#### Pinata
104
103
@@ -107,21 +106,27 @@ keys in order to direct all file uploads through their service. This allows for
107
106
ease of use while working with IPFS as running OpenMinter without Pinata will
108
107
rely on using and maintaining a local IPFS node.
109
108
110
- > **Note:** The example ` testnet ` and ` mainnet ` configurations in the ` config /`
111
- > folder have placeholder Pinata API keys. If you want to use OpenMinter on
112
- > these networks without Pinata, remove the ` pinata ` key from the configuration.
109
+ > ⚠️ **Note:** The example ` testnet ` and ` mainnet ` configurations in the
110
+ ` config /` folder have placeholder Pinata API keys as it's the most robust way
111
+ > to easily persist data on IPFS. Using OpenMinter on these networks without
112
+ > Pinata may cause data loss as the NFT metadata and artifacts must be resolved
113
+ > over IPFS. If you want to use OpenMinter on these networks without Pinata,
114
+ > remove the ` pinata ` key from the configuration, but be aware that this entails
115
+ > running and maintaining your own IPFS gateway in order for your NFT data token
116
+ > remain accessible.
117
+
113
118
114
119
[pinata]: https://pinata.cloud
115
120
116
121
### Starting and Stopping
117
122
118
- During its start process, Minter will create or update Docker services for its
119
- specified environment and also bootstrap the required contracts if their
123
+ During its start process, OpenMinter will create or update Docker services for
124
+ its specified environment and also bootstrap the required contracts if their
120
125
addresses are not defined in the environment's configuration file.
121
126
122
127
#### Sandbox
123
128
124
- To start Minter on a ` sandbox ` network, run:
129
+ To start Minter in a ` sandbox ` network, run:
125
130
126
131
` ` ` sh
127
132
$ yarn start : sandbox
@@ -142,7 +147,7 @@ $ yarn stop:sandbox
142
147
143
148
#### Testnet
144
149
145
- To start Minter on a ` testnet ` network, run:
150
+ To start Minter on the ` testnet ` network, run:
146
151
147
152
` ` ` sh
148
153
$ yarn start : testnet
@@ -161,7 +166,7 @@ $ yarn stop:testnet
161
166
162
167
#### Mainnet
163
168
164
- To start Minter on a ` mainnet ` network, run:
169
+ To start Minter on the ` mainnet ` network, run:
165
170
166
171
` ` ` sh
167
172
$ yarn start : mainnet
@@ -229,7 +234,7 @@ $ yarn log:api --since 5m
229
234
230
235
### Editor Environments
231
236
232
- Docker development images are set up to reload server and web ui on source code
237
+ Docker development images are set up to reload server and web UI on source code
233
238
changes.
234
239
235
240
To setup this project for an IDE, you will want to install NPM dependencies
@@ -263,7 +268,7 @@ $ svc-restart(){docker service scale minter-dev-sandbox_$1=0 && docker service s
263
268
264
269
## Release Builds (WIP)
265
270
266
- Development ui and api server builds can be swapped out for release builds:
271
+ Development UI and API server builds can be swapped out for release builds:
267
272
268
273
``` sh
269
274
$ bin/build-release-images
0 commit comments