Skip to content

Commit 691b619

Browse files
update license
1 parent 0f83e24 commit 691b619

File tree

2 files changed

+40
-18
lines changed

2 files changed

+40
-18
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [2021] [Maker Ecosystem Growth Holdings, INC]
189+
Copyright [2021] [Oazo Apps Limited]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

+39-17
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ Monitor the logs and wait for the migrations to complete. This should be evident
5252
In a second terminal we can then begin the web server instance over http or https (https is required
5353
for testing hardware wallets):
5454

55-
*Note: Make sure you have everything setup correctly according to the configuration explain [here](#Configuration)
55+
\*Note: Make sure you have everything setup correctly according to the configuration explain
56+
[here](#Configuration)
5657

5758
```sh
5859
yarn start
@@ -91,38 +92,59 @@ The application consists of two parts
9192

9293
- custom `express` server
9394

94-
There is the `next.config.js` which contains the configuration for `next.js`.
95-
This configuration is created during build time thus The env variables that are used in this file will be evaluated during *build time*.
95+
There is the `next.config.js` which contains the configuration for `next.js`. This configuration is
96+
created during build time thus The env variables that are used in this file will be evaluated during
97+
_build time_.
9698

9799
Some of the values that are used you can check in the `.env` file.
98100

99101
#### List of the `build-time` env vars:
100102

101-
- `COMMIT_SHA` - The value is used together with `SHOW_BUILD_INFO`. Main usages is to display a commit in the footer. This targets build deployments to staging environments so that the team can see which version the UI reflects. The value could be a branch name or specific commit.
103+
- `COMMIT_SHA` - The value is used together with `SHOW_BUILD_INFO`. Main usages is to display a
104+
commit in the footer. This targets build deployments to staging environments so that the team can
105+
see which version the UI reflects. The value could be a branch name or specific commit.
102106

103-
- `MIXPANEL_ENV` - The value could be either `production` or anything else you'd like to use to denote that it's NOT production. The difference is where the events are sent. For "development" environments the events will be displayed in the dev console within the browser. If the env is set to `production` then all the events will be actually sent to Mixpanel.
107+
- `MIXPANEL_ENV` - The value could be either `production` or anything else you'd like to use to
108+
denote that it's NOT production. The difference is where the events are sent. For "development"
109+
environments the events will be displayed in the dev console within the browser. If the env is set
110+
to `production` then all the events will be actually sent to Mixpanel.
104111

105-
- `MIXPANEL_KEY` - The value will be used for `production` environments. This is the project key that is generated from Mixpanel.
112+
- `MIXPANEL_KEY` - The value will be used for `production` environments. This is the project key
113+
that is generated from Mixpanel.
106114

107-
- `USE_TERMS_OF_SERVICE` - In order to use some functionalities the user should read and accept Terms of Service. For development purposes, this feature can be disabled. You can disable this feature if you'd like to remove that functionality at all. The values are either `0` (disabled) or `1` (enabled).
115+
- `USE_TERMS_OF_SERVICE` - In order to use some functionalities the user should read and accept
116+
Terms of Service. For development purposes, this feature can be disabled. You can disable this
117+
feature if you'd like to remove that functionality at all. The values are either `0` (disabled) or
118+
`1` (enabled).
108119

109-
- `SHOW_BUILD_INFO` - The value will determine whether an information about the build is diplayed in the footer. Currently we display only the build time and commit from which it is built. This targets deployments to staging environments so that the tam can see which version the UI reflects. The value is either `0` (disabled) or `1` (enabled)
120+
- `SHOW_BUILD_INFO` - The value will determine whether an information about the build is diplayed in
121+
the footer. Currently we display only the build time and commit from which it is built. This
122+
targets deployments to staging environments so that the tam can see which version the UI reflects.
123+
The value is either `0` (disabled) or `1` (enabled)
110124

111-
- `INFURA_PROJECT_ID` - This is used in cases where the user hasn't authorized the application to access their wallet ( hasn't connected their wallet - `read-only` mode) or when the application is accessed with a specific provider injected.
125+
- `INFURA_PROJECT_ID` - This is used in cases where the user hasn't authorized the application to
126+
access their wallet ( hasn't connected their wallet - `read-only` mode) or when the application is
127+
accessed with a specific provider injected.
112128

113-
- `ETHERSCAN_API_KEY` - The value is used to create the corresponding etherscan endpoint. For each transaction, there is a url that leads to that TX details in etherscan.
129+
- `ETHERSCAN_API_KEY` - The value is used to create the corresponding etherscan endpoint. For each
130+
transaction, there is a url that leads to that TX details in etherscan.
114131

115-
As mentioned previously, there is also the custom express server part which uses the env variables at *run time*
132+
As mentioned previously, there is also the custom express server part which uses the env variables
133+
at _run time_
116134

117135
#### List of the `run-time` env vars:
118136

119-
- `INFURA_PROJECT_ID_BACKEND` - This is used mainly together with the `<build_time>.USE_TERM_OF_SERVICE`. It is related with Argent internals. On the backend we need to connect to a node in order to verify the wallet that is signing the Terms of Service.
137+
- `INFURA_PROJECT_ID_BACKEND` - This is used mainly together with the
138+
`<build_time>.USE_TERM_OF_SERVICE`. It is related with Argent internals. On the backend we need to
139+
connect to a node in order to verify the wallet that is signing the Terms of Service.
120140

121141
- `CHALLENGE_JWT_SECRET` - Could be any value. This is used on the server to sign JWT message.
122142

123-
- `USER_JWT_SECRET` - Could be any value different from `CHALLENGE_JWT_SECRET`. This is used when the user signs the Terms of Service.
143+
- `USER_JWT_SECRET` - Could be any value different from `CHALLENGE_JWT_SECRET`. This is used when
144+
the user signs the Terms of Service.
124145

125-
*Note: Make sure that you call the process that build the project with the `build-time` vars and make sure that you call the proces that runs the application with the `run-time` vars.*
146+
_Note: Make sure that you call the process that build the project with the `build-time` vars and
147+
make sure that you call the proces that runs the application with the `run-time` vars._
126148

127149
<br>
128150

@@ -149,9 +171,9 @@ yarn test:fix
149171

150172
## License
151173

152-
Copyright (C) 2021 Maker Ecosystem Growth Holdings, INC Licensed under the Apache License, Version
153-
2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain
154-
a copy of the License at
174+
Copyright (C) 2021 Oazo Apps Limited, Licensed under the Apache License, Version 2.0 (the
175+
"License"); you may not use this file except in compliance with the License. You may obtain a copy
176+
of the License at
155177

156178
> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
157179

0 commit comments

Comments
 (0)