Scribd
Upload
10 views

Thumbnail 1562829189

The document provides coding guidelines for a Mother's Education Hub project. It outlines 18 guidelines covering topics like soft deletes, enabling/disabling records, buttons and forms, dependent data, filters, routes, modals, searching, methods/functions, pagination, and more.

Uploaded by

itsm97436
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
10 views

Thumbnail 1562829189

The document provides coding guidelines for a Mother's Education Hub project. It outlines 18 guidelines covering topics like soft deletes, enabling/disabling records, buttons and forms, dependent data, filters, routes, modals, searching, methods/functions, pagination, and more.

Uploaded by

itsm97436
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1

Mother’s Education Hub

Coding guidelines
______________________________________________________________________

1. The concept of delete/soft delete a record will not be used. Instead, enabling or disabling
a record will be used. Soft or permanent deletion will not be used in any case.
2. The enabling and disabling of a record will be achieved by means of a single toggle
button. Button titled ‘Enable’ will be red in colour and ‘Disable’ will be green in colour.
3. All the rows of the master data lists will have at least view, edit and enabled/disabled
button
4. Button for adding a new record will be placed on the upper right hand side corner of the
screen either on the filter section or above the filter section.

5. The only data for the selected vendor should be displayed. Whenever data is fetched for
listing purposes or filter’s dropdown list, vendor check must be included, directly or
indirectly. Indirectly refers to dependent data e.g. batches which would be dependent on
centres. If we are fetching batches for a specific centre, we don’t need to include vendor
search because centres are already vendor specific.
6. For filters, only the enabled records should be displayed in the dropdown lists.
Whenever data is fetched for filter’s dropdown list, check must include only enabled
records.
7. For CRUD operations Resourceful routes should be used.
8. For pop up information, modals should be written in separate blade files with a logical
name and the suffix “_modal”.
9. Search feature across the application will be wild card search
10. Methods/functions : Instead of complex methods/functions performing multiple tasks,
simple smaller methods/functions should be prepared
11. Methods/functions : All the methods/functions should have comment section at the
beginning of it giving the details of :
i. Action performed : <brief description of action performed >
ii. Called from : <a list of views/methods which are calling this methos >
iii. Returning to : < view/method it returns the control to >
12. All the dropdown lists should include the class “select2”. This helps search a desired
value by typing it.
13. While fetching data from table, ‘eager load’ needs to be used instead of ‘lazy load’
14. All the lists of data in all the views need to use backend pagination.
15. While using the filters, the filters information (criteria) needs to be preserved while
displaying the filtered data.
a. 12. Date picker, date range picker and Date time picker to be used of theme we
are using
16. For enabled/disabled record, if the record is disabled, all the other relevant buttons
should be disabled (not hidden)
17. While creating a new master data record (Centre, role, course, batch etc.) duplicity must
be checked.
18. While creating a master data, wherever Centre is required (refer respective table), only
Super Admin will have the authority to select the centre from the centre’s dropdown list.
For rest of all, centre will be picked from auth table, the centre’s dropdown will display
the respective centre and will be disabled for selection.

You might also like