Skip to content

Commit 16ff616

Browse files
issue #184 fixed
1 parent 6ea6eb1 commit 16ff616

File tree

1 file changed

+32
-27
lines changed

1 file changed

+32
-27
lines changed

README.md

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
</p>
1010

1111
## Topics
12+
1213
1. [Introduction](#introduction)
1314
2. [Documentation](#documentation)
1415
3. [Requirements](#requirements)
@@ -32,12 +33,12 @@ a progressive Javascript framework.
3233

3334
It packs in lots of features that will allow your E-Commerce business to scale in no time:
3435

35-
* Descriptive and Simple Admin Panel.
36-
* Admin Dashboard.
37-
* Custom Attributes.
38-
* Built on Modular Approach.
39-
* Email parsing via Sendgrid.
40-
* Check out [these features and more](https://krayincrm.com/features/).
36+
- Descriptive and Simple Admin Panel.
37+
- Admin Dashboard.
38+
- Custom Attributes.
39+
- Built on Modular Approach.
40+
- Email parsing via Sendgrid.
41+
- Check out [these features and more](https://krayincrm.com/features/).
4142

4243
**For Developers**:
4344
Take advantage of two of the hottest frameworks used in this project -- Laravel and Vue.js -- both of which have been used in Krayin CRM.
@@ -48,27 +49,31 @@ Take advantage of two of the hottest frameworks used in this project -- Laravel
4849

4950
### Requirements
5051

51-
* **SERVER**: Apache 2 or NGINX.
52-
* **RAM**: 3 GB or higher.
53-
* **PHP**: 7.3 or higher.
54-
* **For MySQL users**: 5.7.23 or higher.
55-
* **For MariaDB users**: 10.2.7 or Higher.
56-
* **Node**: 8.11.3 LTS or higher.
57-
* **Composer**: 1.6.5 or higher.
52+
- **SERVER**: Apache 2 or NGINX.
53+
- **RAM**: 3 GB or higher.
54+
- **PHP**: 7.3 or higher.
55+
- **For MySQL users**: 5.7.23 or higher.
56+
- **For MariaDB users**: 10.2.7 or Higher.
57+
- **Node**: 8.11.3 LTS or higher.
58+
- **Composer**: 1.6.5 or higher.
5859

5960
### Installation and Configuration
6061

6162
** Or you can install Krayin CRM from your console.**
6263

6364
##### Execute these commands below, in order
6465

65-
~~~
66+
```
6667
1. composer create-project krayin/laravel-crm
67-
~~~
68+
```
69+
70+
- Find **.env** file in root directory and change the **APP_URL** param to your **domain**.
6871

69-
~~~
72+
- Also, Configure the **Mail** and **Database** parameters inside **.env** file.
73+
74+
```
7075
2. php artisan krayin-crm:install
71-
~~~
76+
```
7277

7378
**To execute Krayin**:
7479

@@ -79,29 +84,29 @@ In order to do that, run the command below:
7984

8085
> composer install --no-dev
8186
82-
~~~
87+
```
8388
Open the specified entry point in your hosts file in your browser or make an entry in hosts file if not done.
84-
~~~
89+
```
8590

8691
##### On local:
8792

88-
~~~
93+
```
8994
php artisan serve
90-
~~~
91-
95+
```
9296

9397
**How to log in as admin:**
9498

95-
> *http(s)://example.com/admin/login*
99+
> _http(s)://example.com/admin/login_
96100
97-
~~~
101+
```
98102
99103
password:admin123
100-
~~~
101-
104+
```
102105

103106
### License
107+
104108
Krayin CRM is a truly opensource CRM framework which will always be free under the [MIT License](https://github.com/krayin/laravel-crm/blob/master/LICENSE).
105109

106110
### Security Vulnerabilities
107-
Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in Krayin CRM then please email us: mailto:[email protected].
111+
112+
Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in Krayin CRM then please email us: mailto:[email protected].

0 commit comments

Comments
 (0)