Skip to content

Commit

Permalink
Merge pull request #18 from bunsy-0900/bug/ES-693
Browse files Browse the repository at this point in the history
ES-693: write technical document for signup UI
  • Loading branch information
ase-101 authored Jan 22, 2024
2 parents f580f13 + 4e82503 commit 2cc7795
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions signup-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:

Expand All @@ -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

Expand All @@ -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.

0 comments on commit 2cc7795

Please sign in to comment.