Skip to content

Commit

Permalink
docs: add details to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
icelam committed Jul 6, 2020
1 parent 72bbf1c commit 6983704
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# Hong Kong Identity Card Number Generator and Validator #

Progressive Web Application for generates or validates Hong Kong Identity Card number.
Progressive Web Application for generates or validates Hong Kong Identity Card number.

## Preview Screens ##
![Generator](./docs/hkid-generator-home.png)
![Validator](./docs/hkid-generator-validator.png)

## Setup ##
Below shows some basic setup steps.

### Node version ###
This project is developed using Node.js 10. The version is already specified in the `.nvmrc` file. Suggest to run `nvm use` when you enter the project folder.

### Install packages need for the project ###
Install npm packages in project root folder first using `npm install`.

### To start the project ##
Run `npm dev` in project root folder.

### To build production ###
Run `npm build` in project root folder.

## Configurations ##
Below shows some available configuration options.

### To add / edit Webpack alias ###
To add or edit Webpack alias, modify `resolve.alias` in `webpack/webpack.base.conf.js`.
Binary file added docs/hkid-generator-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hkid-generator-validator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6983704

Please sign in to comment.