first commit

README.md

@@ -0,0 +1,70 @@
+# drc-planning-department-app
+
+This is an application that supports business processing of the DRC planning department.
+
+## Install dependencies
+
+By default, dependencies were installed when this application was generated.
+Whenever dependencies in `package.json` are changed, run the following command:
+
+```sh
+npm install
+```
+
+To clean install, run the following command:
+
+```sh
+npm run install:clean
+```
+
+## Run the application
+
+```sh
+npm start
+```
+
+## Run Argon template UI
+
+```sh
+npm run template
+```
+
+## Build the project
+
+To incrementally build the project:
+
+```sh
+npm run build
+```
+
+## Generate API client
+
+To Generate API client from serveside:
+
+```sh
+npm run generate-api
+```
+
+## Fix code style and formatting issues
+
+```sh
+npm run lint
+```
+
+To automatically fix such issues:
+
+```sh
+npm run lint:fix
+```
+
+## Other useful commands
+
+- `npm run compile:scss`: Compile scss to css
+- `npm run minify:scss`: Compile scss to css and compress it
+- `npm run build:scss`: Compile, minify and build scss
+
+## Tests
+
+```sh
+npm test
+```