Added INstructions and Edit Doc

.env.development

@@ -1,13 +1,13 @@
 REACT_APP_BASE_URL="https://rptest.manaknightdigital.com/"
 REACT_APP_API_URL="https://rptest.manaknightdigital.com/api/"
 REACT_APP_SANCTUM_URL="https://rptest.manaknightdigital.com/sanctum/csrf-cookie"
-REACT_VAPOR_URL="https://api-qa-mongoose-br2wu78v1.rocketplantech.com/vapor/signed-storage-url"
+REACT_VAPOR_URL="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_VAPOR_STORAGE_URL="https://storage-qa-mongoose-br2wu78v1.rocketplantech.com"
+REACT_VAPOR_STORAGE_URL="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_GOOGLE_API_KEY="AIzaSyBcqQuMIk9je3UKcjZCKS5sdKqEfIaNHAk"
+REACT_GOOGLE_API_KEY="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_GOOGLE_API=//maps.googleapis.com/maps/api/js?key=AIzaSyBcqQuMIk9je3UKcjZCKS5sdKqEfIaNHAk&libraries=places
+REACT_GOOGLE_API="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_INTERCOM_ID=t6huw9xl
+REACT_INTERCOM_ID="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_TRANSLOADIT_TEMPLATE_ID=34b580b62cea4964aca081d52e36800a
+REACT_TRANSLOADIT_TEMPLATE_ID="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_TRANSLOADIT_AUTH_ID=b62a748ff0114d87910e454d4aff7f4b
+REACT_TRANSLOADIT_AUTH_ID="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_TRANSLOADIT_LOGO_TEMPLATE_ID=33425f0eff0543778e7cdb2403fa42f6
+REACT_TRANSLOADIT_LOGO_TEMPLATE_ID="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_TRANSLOADIT_AVATAR_TEMPLATE_ID=5a639725d71e43489deeb3bdcf338aec
+REACT_TRANSLOADIT_AVATAR_TEMPLATE_ID="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"
-REACT_APP_PUSHER_APP_KEY=f17c0735529857c8b4e9
+REACT_APP_PUSHER_APP_KEY="bfdblisbilhbidbhbdhbvduybgsifbdobnodbhhcbfndobfoudbfiudbo"

README.md

@@ -1,21 +1,28 @@
+# This project is a toy project for training and quality assurance purposes
+
 # Web App
 
 Boilerplate Webpack 5, React and Bootstrap 5 project with global Css and Css modules enabled.
 
 # Hosts File Config
-In order to run this application in local, you'll need to modify your hosts file configuration. Then you will be able to access/serve your application at https://test.rocketplantech.com:3000
+
+In order to run this application in local, you'll need to modify your hosts file configuration. Then you will be able to access/serve your application at https://test.manaknightdev.com:3000
 
 ### Windows
+
 Please include the following line in your hosts file
 
-`127.0.0.1 test.rocketplantech.com`
+`127.0.0.1 test.manaknightdev.com`
+
+See How to edit your hosts file on Windows [here](https://www.groovypost.com/howto/edit-hosts-file-windows-10/)
 
 ### Mac
+
 Please do the following steps
 
 `sudo nano /private/etc/hosts`
 
-add `127.0.0.1 test.rocketplantech.com` to the end of the file and save
+add `127.0.0.1 test.manaknightdev.com` to the end of the file and save
 
 run `sudo dscacheutil -flushcache` to flush the DNS cache
 
@@ -35,6 +42,11 @@ This will install the nodule modules
 
 `yarn run start`
 
+The Webpack build has a lot of outputs, if this is not intterupted then allow it to completely build for the first time... consecutive builds on "save" are faster after the first build.
+
+In the event you run into any error with the build failing
+for this project you can downgrade your `node version to 14 or 16`
+
 # Staging Build
 
 `yarn run staging`
@@ -45,19 +57,43 @@ This will install the nodule modules
 
 # Task
 
-- To login go to https://test.rocketplantech.com:3000/
+- To login go to https://test.manaknightdev.com:3000/
-- kevin@rocketplantech.com / Abcdef123
+
-- Create the form page https://test.rocketplantech.com:3000/form as in screenshot_1
+- devtest@manaknightdev.com / Abcdef123
-- Create delete modal and it can delete the form as well screenshot_2
+
-- When we click on add button, it will open modal popup showing form. need to integrate the ADD FORM api
+- Create the form page https://test.manaknightdev.com:3000/form as in screenshot_1
-- Need to integrate API to load the table
+
+- Need to integrate API to load the table <a href="#get_form">go to doc</a>
+
+- When we click on add button, it will open modal popup showing form. need to integrate the ADD FORM api <a href="#add_form">go to doc</a>
+
+- When we click on a form on the list, it will open modal popup showing form with saved details of the form. need to integrate the EDIT FORM api <a href="#edit_form">go to doc</a>
+
+- Create delete modal and it can delete the form as well screenshot_2 <a href="#delete_form">go to doc</a>
+
+## Important Detail
+
+The popup modal that shows the form has two sections, the left panel and the right panel.
+
+- **The Left Panel**: this is a list of template strings starting with three tilds and ending with three tilds => `~~~name~~~`
+  when a template is clicked, it is added to the right panel which is a `<textarea></textarea>` as you see in screenshot_3.
+
+- **The Right Panel**: this is a `<textarea></textarea>` where you can type in any text of your choice and also add templates by clicking on a template on the left panel as you see in screenshot_3.
+
+<div id="get_form">
 
 ## API for getting Contract Forms
+
 ```
 GET `/companies/${companyId}/contract-forms`
 ```
 
+</div>
+
+<div id="add_form">
+
 ## API for Adding Contract Forms
+
 ```
 Request Body: {
 company_id: companyId,
@@ -72,7 +108,34 @@ has_signature: true || false,
 ```
 POST  `/contract-forms`
 ```
-## API for deleting Contract Forms
+
+</div>
+
+<div id="edit_form">
+
+## API for Editing Contract Forms
+
+```
+Request Body: {
+company_id: companyId,
+name: formName,
+replacement_tags: typeof String,
+status: 'active',
+template: typeof string,
+has_signature: true || false,
+}
+```
+
+```
+PUT  `/contract-forms`
+```
+
+</div>
+
+<div id="delete_form">
+
 ```
 DELETE `/contract-forms/${contractId}`
 ```
+
+</div>

config/webpack.dev.js

@@ -24,7 +24,7 @@ module.exports = merge(common, {
     compress: true,
     hot: true,
     port: 3000,
-    host: 'test.rocketplantech.com',
+    host: 'test.manaknightdev.com',
     https: true,
     noInfo: true, //This turns off information regarding the bundle.  Set to false if you need to view the messages
   },

package.json

@@ -10,7 +10,8 @@
     "lint-staged": "lint-staged",
     "prepare-husky": "husky install",
     "storybook": "start-storybook -p 6006",
-    "test": "npx cypress open"
+    "test": "npx cypress open",
+    "commit": "git add . && git commit -m \"Update Host\" && git push"
   },
   "husky": {
     "hooks": {