diff --git a/README.md b/README.md index 1aed7e8..815d526 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,11 @@ 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.manaknightdev.com:3000 ### Windows + Please include the following line in your hosts file `127.0.0.1 test.manaknightdev.com` @@ -15,6 +17,7 @@ Please include the following line in your hosts file 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` @@ -55,18 +58,42 @@ for this project you can downgrade your `node version to 14 or 16` # Task - To login go to https://test.manaknightdev.com:3000/ + - devtest@manaknightdev.com / Abcdef123 + - Create the form page https://test.manaknightdev.com:3000/form as in screenshot_1 -- 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 -- Need to integrate API to load the table + +- Need to integrate API to load the table go to doc + +- When we click on add button, it will open modal popup showing form. need to integrate the ADD FORM api go to doc + +- 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 go to doc + +- Create delete modal and it can delete the form as well screenshot_2 go to doc + +## 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 `` as you see in screenshot_3. + +- **The Right Panel**: this is a `` 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. + +
## API for getting Contract Forms + ``` GET `/companies/${companyId}/contract-forms` ``` +
+ +
+ ## API for Adding Contract Forms + ``` Request Body: { company_id: companyId, @@ -81,7 +108,34 @@ has_signature: true || false, ``` POST `/contract-forms` ``` -## API for deleting Contract Forms + +
+ +
+ +## 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` +``` + +
+ +
+ ``` DELETE `/contract-forms/${contractId}` -``` \ No newline at end of file +``` + +