diff --git a/signup-ui/README.md b/signup-ui/README.md index 4cb9d99d..5b938eb3 100644 --- a/signup-ui/README.md +++ b/signup-ui/README.md @@ -2,7 +2,7 @@ ## Description -The E-Signet Sign Up web application is a platform allowing L1 and L2 users in Cambodia to register their identities. +The E-Signet Sign Up web application is a platform allowing users to register their identities. ## Local Development @@ -18,7 +18,7 @@ npm install #### Browser -During development, we were using Chrome for debugging. You are recommended to open Chrome with --disable-web-security mode to avoid CORS errors. +During development, it is recommended to use Chrome, and it needed to be open with --disable-web-security mode to avoid CORS errors. Mac users use the following command: @@ -42,7 +42,7 @@ To start the web application, run the following script: npm start ``` -This opens [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console. +This opens [http://localhost:3000](http://localhost:3000) to view it in the browser. ##### Storybook @@ -52,12 +52,17 @@ To start the storybook, run the following script: npm storybook ``` -This opens [http://localhost:6006](http://localhost:6006) in the browser. Making change to your components triggers hot reload in storybook. +This opens [http://localhost:6006](http://localhost:6006) in the browser. Making change to the components in the project triggers hot reload in storybook. #### Environments -We provide you with `.env.example` file. You can copy and paste the variables described into a self-created `.env.local` file, replacing the required values with your own. +`.env.example` file is provided in the root folder. In the development, copy and paste the variables described into a self-created `.env.local` file, replacing the required values accordingly. + +By default, the environment variables are: +| variable | value | +| -------- | ----- | +| `REACT_APP_API_BASE_URL` | http://localhost:8088/v1/signup | #### Translation -You can add translations using the `locales` folder in the `public` folder. You will need to add the newly added key(s) to `resource.d.ts` so that you can get translation key suggestion. +New translations can be added in the `locales` folder of the `public` folder. Also, newly added key(s) need to be added to `resource.d.ts` to fulfill the type and get the key suggestion.