TP-24538: Initial commit for the base setup for the houston-ui

README.md

@@ -0,0 +1,60 @@
+# alfred-ui
+
+### Install Yarn
+
+```
+npm install yarn -g
+```
+
+### Setup
+
+Install dependencies
+
+```
+yarn install
+```
+
+In case of network timeout
+
+```
+yarn install --network-timeout 1000000000
+```
+
+Create following files in the project root.
+Ask the fellow devs for api keys and copy paste them in respective files.
+
+```
+config.dev.js
+config.qa.js
+```
+
+Start dev server with dev config
+
+```
+yarn dev
+```
+
+For production build
+
+```
+yarn build
+yarn preview
+```
+
+## Check Eslint-Prettier
+
+```
+yarn eslint-check
+yarn lint
+yarn prettier-check
+```
+
+```
+Please go through <strong>package.json</strong> for the scripts.
+```
+
+```
+Useful Resources:
+1. Configure CSP ref: https://stackoverflow.com/questions/43453624/how-to-figure-out-a-reasonable-content-security-policy-source-for-nginx-virtual
+2. Verify your CSP using this link: https://csp-evaluator.withgoogle.com/
+```