If you are able to get login page when you access the script from your browser, it means you have successfully installed the application. Now its time to configure the script, to select the features you want in the script. This is very important to use the script.
After completing the installation, you can login with the admin login details which you have entered during installation phase.
For first account (which will be default admin account), there will not be any kind of email verification. You can just log in with your email & password which you have used to create your first account.
By default, the email driver is set to "log", which means you will be able to send emails but all the emails are logged at storage/logs/laravel.log file. So you can open this file & can read the email. This is important in case you haven't set any email driver and forget your password. You can just go to this file and search for "Password Reset Email". Once you get this email, you can copy the password reset email link in your browser & then reset your password with few clicks.
Once you are logged into dashboard, you might find empty menu items. Do not worry, everything needs to be enabled in configuration page. Click on the (Configuration) menu available in the top right header. This menu is by default available for "admin" user and need not any kind of configuration.
Follow below steps to complete the configuration:
Required Go to configuration "basic" tab, complete the basic info about your company.
Optional Move to "Logo" tab, select both logo i.e. Main logo & Sidebar Logo.
Required Move to "System" tab, choose your color theme, direction to display, date format, time format, notification position, locale & timezone. Next, choose the features you want to enable by switching on the various feature.
Please note, if any feature is not switched on here, you will not be able to experience it in your application. You can any time switch it on/off as per your requirement.
Required Move to "Mail" tab, choose your mail driver & enter desired fields depending upon your mail driver. The script only provides a method to send emails and doesn't bear any cost of sending email. You are free to choose any email driver listed over there.
Optional Move to "Locale" tab, you might want to have this script in your own locale. Default locale supported in this script is English (en). Built-in language translator can make your job easy. Add your new locale here, go to translation & save translation for all possible words. Now move to "System" tab & choose your locale. That's it.
Required Move to "Role" tab, create new roles (If required). Script supports two default roles (1) Admin (2) User. Both role can not be deleted. Also note that roles can not be edited. The script uses spatie/laravel-permission package to manage roles & permissions. You should visit this link to know more about this package.
Required Move to "Permission" tab, create new permissions (If required). Script supports many default permissions. Permissions once created can not be edited. Once you create permission, you can click on the "Assign Permission" button to assign permission based on the roles. You can simply switch on/off the button of any roles to enable/disable permission.
The script uses spatie/laravel-permission package to manage roles & permissions. You should visit this link to know more about this package.
Required Move to "Menu" tab, Choose the menu option which you want to see in the left sidebar. Once you click on "save", you will be able to see the menu list in the left sidebar. If it is not visible, click on any other link and menu list should appear now in the left side bar.
Optional Move to "SMS" tab, The script supports Nexmo SMS API. If you have live Nexmo account with SMS balance then you can send SMS from this script. Currenly, Nexmo SMS API is used to send Two Factor Authentication code to the user. If you want to add it anywhere else, you can do it by writing few lines of code.
Required Move to "Authentication" tab, There are various authentication variable available in the script. You can change this variable as per your requirement.
Optional Move to "IP Filter" tab, If you wish the script to be available to selected range of IPs then you can achieve this functionality by defining a range of IPs in this script.
Important Note: Always enter your IP first in the system else you will get yourself blocked and you won't be able to access the script. The only way to escape from this is to disable this feature from database by setting "ip_filter" value to 0 in the config table.
Required Next move to "Module Configuration" option available in the header menu for admin user. Here you will get a list of configurations related to various modules as below:
- Customer Group - You can create multiple customer groups to categorize them.
- Currency - The script supports multiple currencies. Here you can create and manage existing currencies. Each currency name should follow ISO 4217 format of standard currency.
- Taxation - You can create multiple taxations, set its rate and then use it during item creation or invoice generation.
- Expense/Income Category - Create some ledger account for Expense & Income. Use it during transactions.
- Item Category - Categorize your items with multiple categories. Choose item is in form of product or services.
- Invoice - Here you will get list of configuration related to invoices like prefix of invoice number, invoice starting number etc.
- Quotation - Here you will get list of configuration related to quotations like prefix of quotation number, quotation starting number etc.
- Payment Method - Manage multiple payment methods related to income, expense and money transfer between accounts.
Optional Move to "Schedule Job" tab, In Laravel framework you can define scheduler commands. The script uses same scheduler command feature. The script can send Birthday/Anniversay wish to staff or can generate daily backup at certain time period. You can go to app/Console folder & change the setting.
To know more about Laravel scheduler visit here.