Skip to content

Commit

Permalink
Updated Images and Content
Browse files Browse the repository at this point in the history
  • Loading branch information
@RishabhYogi-Webkul
RishabhYogi-Webkul committed Oct 22, 2024
1 parent 2ce0974 commit 7471984
Show file tree
Hide file tree
Showing 157 changed files with 767 additions and 111 deletions.
2 changes: 2 additions & 0 deletions docs/.vuepress/version-configs/2.0.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@ module.exports = [
['settings/pipeline', 'Pipelines'],
['settings/source', 'Sources'],
['settings/type', 'Types'],
['settings/warehouse', 'Warehouses'],
['settings/attribute', 'Attributes'],
['settings/emailtemplate', 'Email Templates'],
['settings/webhooks', 'Webhooks'],
['settings/workflow', 'Workflows'],
['settings/webforms', 'Web Forms'],
['settings/tags', 'Tags'],
Expand Down
44 changes: 33 additions & 11 deletions docs/2.0/activity/activities.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,50 @@ There are by default 3 Activities present in Krayin CRM.

### To create an Activity follow the below steps.

**Step-1** Go to admin panel click on **Leads >> Open Lead >> Click on Activity** and add the details listed below.
Go to the admin panel click on **Leads >> Open Lead >> Click on Activity** and add the details listed below.

**1) Title-** Add the title of the activity.
**1) Add Activity-** Select the activity from the dropdown i.e. Call, Lunch, Meeting

**2) Type-** Select the type of the meeting from the options **lunch, call, meeting**
**2) Title-** Add the title of the activity.

**3) Schedule-** Schedule a date for the activity.
**3) Description-** Enter the detailed description of the selected activity.

**4) Location-** Add the location for the activity.
**4) Participants-** Add the participants from the activity.

**5) Description-** Add the description of the activity.
**5) Schedule-** Schedule a date **From** and **To** for the activity.

**6) Participants-** Add the participants from the activity.
**6) Location-** Add the location for the activity.

Now click on the **Save** button
Now click on the **Save Activity** button

![Create Activity](../../assets/2.0/images/activity/createActivity.png)

Now it will be visible where activity is created check the below image.
Now it will be visible where activity is created in the **All** & **Lunch, Call, Meeting** sections accordingly as shown in the below image.

![Activity](../../assets/2.0/images/activity/activity.png)

**Step-2** Now a new record is created click on **Activity** to check the record in the activity grid.
Now the created Activity becomes visible in the activity grid as shown in the image below.

![Activity Grid](../../assets/2.0/images/activity/activityGrid.png)
![Create Activity](../../assets/2.0/images/activity/activityGrid.png)

### Calendar View

After the creation of the activity, you can see it in the Activities tab directly. You can also find out your desired activity when you click Calendar view according to the created date and time.

![Activity Grid](../../assets/2.0/images/activity/calender.png)

### Edit or Delete the Activity

By using the Actions tab you can edit or delete the activity as shown in the image.

![Activity Grid](../../assets/2.0/images/activity/editActivity.png)

### Use of Filter

Here you can use the Filter tab to find out the desired activity.

By default, there are **Title, Created By, Lead, Schedule From, Schedule To, Created At** filters available as shown in the image below.

![Activity Grid](../../assets/2.0/images/activity/filter.png)

By following the above steps you can easily create & manage activity in Krayin CRM.
9 changes: 5 additions & 4 deletions docs/2.0/configure/configuration.md
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# Configuration

Manage the configurations from here also you can change the locals (languages) in this section.
You can manage the configurations here and also change the local languages from the configuration.

### Manage Locale in Krayin

**Step-1** Go to admin panel of krayin and click on **Configuration >> Locale Setting**.
**Step-1** Go to admin panel of krayin and click on **Configuration >> General >> Locale Setting**.

**Step-2** Now select your desired locale from the dropdown as shown in the below image.
**Step-2** Now select your desired locale from the dropdown by default, we provide **English, Arabic, Spanish, Persian, and Turkish** languages.

Now click on the **Save** button.

![Configure](../../assets/2.0/images/configure/locale.png)

**Step-3** As we have selected the Arabic local layout gets updated according to the arabic language as shown in the below image.
**Step-3** As we have selected the Arabic local layout gets updated according to the Arabic language as shown in the below image.

![Arabic](../../assets/2.0/images/configure/arabic.png)

By following the above steps you can easily use multiple Locales in Krayin CRM.



52 changes: 41 additions & 11 deletions docs/2.0/contact/contacts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,37 @@ This individual could be a customer, a lead, a prospect, or any other person wit

**1) Name-** Enter the name of the person.

**2) Emails-** Enter the email ID of the person.
**2) Emails-** Enter the email ID of the person from the dropdown you can select whether it is your work email or home email.

**3) Contact Number-** Enter the contact details
**3) Contact Number-** Enter the contact details you can select whether it is your work contact number or home contact number.

**4) Organization-** Enter the name of the organization.
**4) Job Title-** Enter the Job Title of the person

**5) Sales Owner-** Enter the sales owner.

**6) Organization-** Enter the name of the organization.

![Person](../../assets/2.0/images/contact/person.png)

Now click on **Save as Person** button.

**Step-3** Now a new record is created click on **Persons** to check the record in the Contact Person grid.
**Step-3** Now a new record is created click on Persons to check the record in the contact person data grid.

![Person](../../assets/2.0/images/contact/personGrids.png)

### Edit or Delete the Person

By using the Actions tab you can edit or delete the person as shown in the image.

![Person](../../assets/2.0/images/contact/action.png)

### Filters for Person

Here you can use the Filter tab to find out the desired person.

![Person Grid](../../assets/2.0/images/contact/personGrid.png)
By default, there are **ID, Name, Emails, Contact Numbers, Organization Name** filters available as shown in the image below.

![Person](../../assets/2.0/images/contact/personFilter.png)

## Orgnization

Expand All @@ -40,20 +58,32 @@ It could be a commercial enterprise, a non-profit organization, a government age

**Step-1** Go to admin panel of krayin and click on **Contacts >> Organizations >> Create Organization** as shown in the below image.

![Create Organization](../../assets/2.0/images/contact/createOrganization.png)
![Person](../../assets/2.0/images/contact/createOrganization.png)

**Step-2** Add the below details briefly.

**1) Name-** Enter the name of the organizations.

**2) Address-** Enter the address of the organization **County State City Pincode**

Now click on **Save as Organization** button.
**3) Sales Owner-** Enter the sales owner.

Now click on **Save Organization** button.

![Person](../../assets/2.0/images/contact/organization.png)

**Step-3** Now a new record is created in the contact organization data grid.

![Person](../../assets/2.0/images/contact/organizationGrid.png)

### Filters for Organization

Here you can use the Filter tab to find out the desired organization.

![Organization](../../assets/2.0/images/contact/organization.png)
By default, there are **ID, Name, Created At,** filters available as shown in the image below.

**Step-3** Now a new record is created in the contact organization grid you can use this organization while creating a lead.
![Person](../../assets/2.0/images/contact/organizationFilter.png)

![Organization Grid](../../assets/2.0/images/contact/organizationGrid.png)
**NOTE-** These above **Persons** and **Organization** you can assign it while creating a lead.

**NOTE-** These above **Persons** and **Organization** you can assign it while creating a lead.
By following the above steps you can easily create Persons & Organizations in Krayin CRM.
18 changes: 14 additions & 4 deletions docs/2.0/lead/leads.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ A Lead is a potential customer or prospect. Generating a lead is the first step

**4) Source-** Select the Source from where you got connected with the customer by Emails, Web, Web Form, Phone, and Direct platforms.

**5) Type-** Select the type whether it is the Existing Business or a New Business.
**5) Type-** Select the type for the lead.

**6) Sales Owner-** Select a sales owner.
**6) Sales Owner-** Select a sales owner for the lead.

**7) Expected Close Date-** Enter the expected close date of the Lead.

Expand Down Expand Up @@ -56,6 +56,16 @@ Click on the lead below as shown in the below image.

![Lead Output](../../assets/2.0/images/lead/leadOutput.png)

**A complete pipeline is created you can also add the steps in the pipeline as shown in the below image**
**A complete pipeline is created you can also add the steps in the pipeline**

![Pipeline](../../assets/2.0/images/lead/pipeline.png)
![Pipeline](../../assets/2.0/images/lead/pipeline.png)

### Filter in Lead

Here you can use the Filter tab to find out the desired lead.

By default, there is **ID, Lead Value, Sales Person, Contact Person, Lead Type, Source, Tags, Expected Close Date, Created At,** filters available as shown in the image below.

![Pipeline](../../assets/2.0/images/lead/leadFilter.png)

By following the above steps you can easily create Leads in Krayin CRM.
44 changes: 29 additions & 15 deletions docs/2.0/mail/mails.md
View file
Original file line number Diff line number Diff line change
@@ -1,59 +1,73 @@
# Mails

**Mail** typically refers to electronic mail, commonly known as email. It's a method of exchanging digital messages between people using electronic devices such as computers, smartphones, and tablets. Email is widely used for communication in both personal and professional settings. It allows users to send text-based messages, attachments (such as documents, images, or videos), and other digital content to one or more recipients over the internet. Email can be used for various purposes, including sending messages, sharing information, collaborating on projects, and conducting business communications.
**Mail** typically refers to electronic mail, commonly known as email. It's a method of exchanging digital messages between people using electronic devices such as computers, smartphones, and tablets. Email is widely used for communication in both personal and professional settings.

Email can be used for various purposes, including sending messages, sharing information, collaborating on projects, and conducting business communications.

## Compose

To compose an email is another term for writing an email. For many email providers, you see a button that says “compose email” which, when clicked on, will let you start writing an email to be sent to a recipient.
**To** An ‘address bar‘ where you put the email address

**Subject:** ‘Subject bar’ is the title of your message, where you write what your email is about

Then enter the main body of your email where you write your message.

![Compose Mail](../../assets/2.0/images/mail/composeEmail.png)

To send mail click on **Send** Button
**Add Attachment:** There is an option for attaching a file if you want to attach some files with email.

## Inbox
**Save to Draft:** You can save mail into the draft also.

An inbox is a primary location where all incoming emails are stored in an email account. The first screen appears when you log in to your email account. The inbox displays the list of emails you have received, along with their subject lines, senders, and the date and time they were received.
![Compose Mail](../../assets/2.0/images/mail/attachment.png)

A list of Emails is stored as shown in the below image.
## Inbox

Here you can see all the incoming emails. You can search mail from the Search Here and if you want to perform any action then select the email from the checkbox Select Action from the drop-down and Submit that.

![Mail Inbox](../../assets/2.0/images/mail/mailInbox.png)

## Draft

A draft in email refers to an unsent email message that is saved as a work-in-progress. Drafts are a useful feature in email because they allow users to start composing an email message, but then save it to be finished or edited at a later time.

A list of draft emails is stored as shown in the below image.
While sending mail to the sender, if you saved the message in the draft, so you see in this section. You can edit or delete the mail also using the Actions tab in the below screenshot.

![Mail Draft](../../assets/2.0/images/mail/mailInbox.png)
![Mail Inbox](../../assets/2.0/images/mail/mailDraft.png)

## Outbox

An outbox is a folder in your email client that stores messages that have been composed but have not yet been sent. The messages remain in the outbox until they are successfully sent, at which point they are moved to the sent items folder.
An outbox is a folder in your email client that stores messages that have been composed but have not yet been sent.

The messages remain in the outbox until they are successfully sent, at which point they are moved to the sent items folder.

A list of outbox emails is stored as shown in the below image.

![Mail Outbox](../../assets/2.0/images/mail/mailOutbox.png)

## Sent

With e-mail, Sent or Sent items is a folder or area that stores any e-mails that were successfully delivered. The sent items are different than the outbox, it's where e-mail stays until it's delivered.

A list of sent emails is stored as shown in the below image.
In this field, you can see all send mails, using Actions you can see the mail and delete the mail also if it is not in use.

![Mail Sent](../../assets/2.0/images/mail/mailSent.png)

## Trash

The Trash folder is where emails are temporarily stored after being deleted from the Inbox or other folders. Emails in the Trash folder are usually automatically permanently deleted after a certain period of time, for example, 30 days.
The Trash folder is where emails are temporarily stored after being deleted from the Inbox or other folders. Emails in the Trash folder are usually automatically permanently deleted after a certain period, for example, 30 days.

A list of trash emails is stored as shown in the below image.

![Mail Trash](../../assets/2.0/images/mail/mailTrash.png)

### Use of Filter in Mails

In Filter, you can find out filtered mail for that you have to put **ID, From, Subject, Tag Name, and Created At**. The same filter you can find in Draft, Inbox, Sent, and Trash. You can find out all deleted messages in the Trash.

![Mail Trash](../../assets/2.0/images/mail/mailFilter.png)

**NOTE-** Kindly add the **SMTP details** in the **.env** file which is present in the root directory of Krayin to enable the functionality to send Emails.

![SMTP](../../assets/2.0/images/mail/emailSmtp.png)

By following the above steps you can easily use Mail functionality in Krayin CRM.




Expand Down
46 changes: 41 additions & 5 deletions docs/2.0/product/products.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,56 @@ Products encompass tools and functionalities designed to manage customer relatio

**3) SKU-** Enter the SKU of the product.

**4) Quantity-** Enter the quantity of the product.

**5) Price-** Enter the price of the product.
**4) Price-** Enter the price of the product.

Now click on **Save as Product** button to save the product.

![Product](../../assets/2.0/images/product/product.png)

**Step-3** Now a new record is created in the product data grid as shown in the below image.

![Product Grid](../../assets/2.0/images/product/productGrid.png)
![Product Grid](../../assets/2.0/images/product/productdataGrid.png)

### Mass Delete Products

You can delete all products at the same time by clicking on a check box and then clicking on Delete as shown in the below image.

![Product Grid](../../assets/2.0/images/product/massDelete.png)

### Use of Filter in Products

You can search the products by using **SKU, Product Name, and Price** as filters as shown in the below image.

![Product Grid](../../assets/2.0/images/product/filtersProducts.png)

### Actions in Products

There are three types of actions you can perform in the Products section:

1) Edit
2) Delete
3) View

**A) Edit Products**

After Products creation, if you want to edit the Product **Name, Description, SKU, and Price** then go to the “Edit” option and click on **Save Product** button after making changes.

![Products edit](../../assets/2.0/images/product/editProduct.png)

**B) Deleting Products**

If you want to delete an unnecessary Products from your Krayin CRM, in the action click on **Delete** button, as shown in the below image.

![Delete Grid](../../assets/2.0/images/product/deleteProduct.png)

**C) View Products**

If you want to view a Product or make some edits like if you want to add **Files, Notes** from your Krayin CRM, in the action click on **View** button and easily add the Files, Notes, and the data will get visible in **Notes, Files and All** sections respectively as shown in the below image.

**NOTE-** This product can be assigned while creating a lead.
![Grid](../../assets/2.0/images/product/viewProduct.png)

**NOTE-** These products can be assigned while creating a lead.

By following the above steps you can easily create quotes in Krayin CRM.


Loading

0 comments on commit 7471984

Please sign in to comment.