ISSUE: #30 - Migrate client-admin to Webpack

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Bugs
 
+- [#30](https://github.com/DFE-Digital/polis-whitelabel/issues/30) Migrated client-admin from Gulp 3 to Webpack
 - [#5](https://github.com/DFE-Digital/polis-whitelabel/issues/5) Restored Docker build process
 - [#1](https://github.com/DFE-Digital/polis-whitelabel/issues/1) Fixed `authorUid is undefined` crash in `server`
 - [#3](https://github.com/DFE-Digital/polis-whitelabel/issues/3) Fixed crash when `.headersJson` file not present for `file-server`

client-admin/.babelrc

@@ -5,7 +5,7 @@
   ],
   "plugins": [
     ["@babel/plugin-proposal-decorators", { "legacy": true }],
-    ["@babel/plugin-proposal-class-properties", { "loose": true }],
+    ["@babel/plugin-proposal-class-properties"],
     "lodash",
     "@babel/plugin-transform-runtime"
   ]

client-admin/.dockerignore

@@ -26,15 +26,9 @@ Desktop.ini
 $RECYCLE.BIN/
 
 # App specific
-build
 dist
-coverage
 node_modules
-bower_components
-.tmp
-lib
 npm-debug.log
-.polis_s3_creds_client.json
 .env_dev
 
 # VCS

client-admin/.gitignore

@@ -1,6 +1,7 @@
 .polis_s3_creds_client.json
 .tmp
-build
-coverage
 dist
-lib
+node_modules
+npm-debug.log
+.env_dev
+polis.config.js

client-admin/README.md

@@ -1,68 +1,48 @@
-# polis-client-admin
+# Polis Admin Console
 
-Polis Admin Console.
+This is the front-end code for the administrators.
 
 ## Dependencies
 
-* node `11.15.0`
-* npm `7.0.15`
+* node `18.12.1`
+* npm `8.19.2`
 
 ## Setup
 
 ```sh
-n 11.15.0
-npm install -g npm@7.0
+n 18.12.1
 npm install
+cp polis.config.template.js polis.config.js
+npm run build:prod
 ```
 
-## Common Problems
+From here go to `file-server` and run `make` to copy the built files across.
 
-If you having troubles with npm dependencies try run the commands below:
+You can run `npm run build:dev` to get an unminified version which makes for easier in-browser debugging.
 
-```sh
-npm cache clear
-npm install
-```
 
-## Building and Deploying for Production
-
-To build static assets for a production deployment, run:
+## Running Application
 
 ```sh
-gulp dist
+nvm use 14.14.0
+npm start
 ```
 
-As a convenience, the `npm deploy:prod` is provided for deploying to AWS S3 or
-via SCP to a static file server. For S3 deployment, place your AWS credentials
-in a JSON file at `.polis_s3_creds_client.json` that looks like this:
-
-```json
-{"key": "XXXXXXX", "secret": "YYYYYYY"}
-```
+## Running Tests
 
-## QA Steps
+We aspire to use the Jest Testing Framework. We welcome contributors to help us write tests!
 
-### Static, outide
-
-- User can see home page at `/home`
-- User is redirected to `/home` if not logged in
-- User can sign in at `/signin`
-- User can reset password at `/pwreset`
-- User can `/createuser` and make a new account, login
-- User can see `/privacy` policy
-- User can see `/tos`
-- User can see `/cookies`
-- User can see `/accessibility`
+```sh
+# Doesn't work right now. Will need to reinstall jest.
+npm test
+```
 
-### After login
+## Building for Production
 
-- User can get `/integrate` embed code for whole site
-- User can see social linkage at `/account`
-- User can see all of their conversations
+To build static assets into `dist/` for a production deployment, run
 
-## Icons from the Noun Project
+```sh
+npm run build:prod
+```
 
-* Checklist by David Courey from the Noun Project
-* AI by mungang kim from the Noun Project
-* Science by Akriti Bhusal from the Noun Project
-* Success File by Ben Davis from the Noun Project
+Deployment is currently performed via Docker, and so no other deployment scripts are provided.