Skip to content

Commit 5ab6bf8

Browse files
committed
Updated Documentation
1 parent 9817f2a commit 5ab6bf8

File tree

6 files changed

+86
-1
lines changed

6 files changed

+86
-1
lines changed

README.md

+86-1
Original file line numberDiff line numberDiff line change
@@ -207,4 +207,89 @@ Just like reviews, each message as a separate _drawer_. Clicking on the drawer w
207207

208208
On this page, all sorts of statistics are available for analysis. These statistics include sales, orders, views, users, various comparison graphs, etc.
209209

210-
### Configurations
210+
### Configurations
211+
212+
This page allows you to change certain configurations of the website. In order to use this, knowledge of `JSON` language is required because these configurations are stored in json format.
213+
214+
There are 4 configuration file that control certain aspects of the website. Each described below:
215+
216+
#### Slider.json
217+
This configuration is for the _full width image slider_ on the homepage of the website.
218+
219+
Each image has a caption and a sub caption. Any number of slider images are possible, but it does affect the page loading time. Thus, about 3 images would be just fine. The image path has to be provided in the `image` key of json.
220+
221+
The 2 captions keys in json are - `captionBig` and `captionSmall`, for a caption and sub caption respectively.
222+
223+
The caption and the sub caption, both have it's own (MaterializeCSS) classes. These keys are available in the json as well, namely `captionBigClasslist` and `captionSmallClasslist`. Use these to change the colors of the caption. Refer MaterializeCSS [website](https://materializecss.com) for color classes.
224+
225+
To add/remove a slider image, simply add/remove objects to the array.
226+
227+
Refer MaterializeCSS [website](https://materializecss.com) for more information on the _full width slider_.
228+
229+
The JSON slider data looks like this:
230+
<p align="center">
231+
<img src="./documentation/images/sliderjson.PNG">
232+
</p>
233+
234+
#### Team.json
235+
236+
This file maintains a list of current team members of Malgadi Electronics. Further, this list is used on the about page to display images and in notifications.json for configurations. Thus team.json is important to maintain. It looks like this:
237+
238+
<p align="center">
239+
<img src="./documentation/images/teamjson.PNG">
240+
</p>
241+
242+
Save the image in the given directory and provide the relative path in the `image` key. The `email` key is required for notifications (for notifications.json).
243+
244+
Simply add/remove the objects as shown in the json array to add/remove team members.
245+
246+
> **Please Note**<br>
247+
> In order to display team member images properly on the about page, the dimension of all images should be _square_.
248+
249+
#### Notifications.json
250+
In this application, whenever an there is some activity on the website - placing an order, submitting a message, etc., The desired team members are notified automatically by email. This file stores the name of the people to be notified on various events as explained below.
251+
252+
- **orderPlaced**: When a new order is placed through the website.
253+
- **newMessage**: When a user submits a _contact message_ / _special order_.
254+
- **newReview**: When a new review is posted.
255+
- **orderCanceled**: When an order is canceled through the member section.
256+
257+
The file looks like this:
258+
259+
<p align="center">
260+
<img src="./documentation/images/notificationsjson.PNG">
261+
</p>
262+
263+
> **Important**<br>
264+
> - Use exact names used in the team.json file because it fetches the email of the person from team.json file.
265+
> - Do not put more than 3 names per category because there is some time cost in sending these email.
266+
267+
#### Contacts.json
268+
269+
When the _call_ button is pressed on the website, the following modal pops up:
270+
271+
<p align="center">
272+
<img src="./documentation/images/contactmodal.PNG">
273+
</p>
274+
275+
This file configures the people shown in this modal.
276+
277+
The file looks like this:
278+
279+
<p align="center">
280+
<img src="./documentation/images/contactsjson.PNG">
281+
</p>
282+
283+
This file's on it's own. Thus, names can be different in it. You may use the same image path used in the team.json.
284+
285+
Simply add/remove objects in the array to add/remove people from the contact modal. Any number of people in the modal is possible but 3 is most favourable.
286+
287+
---
288+
## **Other Provisions**
289+
290+
### Database Auto Baskup
291+
The folder `/db-backup` contains a backup generator of the database. It generates a database backup in the same folder updated every week. So if anything was to happen to the database, you may find a backup in this folder.
292+
293+
---
294+
295+
This covers everything that is required to run the website without any issues. If everything is followed in the documentation, the website is least likely to show any errors ever.

documentation/images/contactmodal.PNG

26.9 KB
Loading

documentation/images/contactsjson.PNG

15.8 KB
Loading
10.7 KB
Loading

documentation/images/sliderjson.PNG

27.1 KB
Loading

documentation/images/teamjson.PNG

19.5 KB
Loading

0 commit comments

Comments
 (0)