Skip to content

Commit 679e277

Browse files
classiebitclassiebit
committed
Update readme & prepare for final release
1 parent e78737c commit 679e277

File tree

3 files changed

+291
-6
lines changed

3 files changed

+291
-6
lines changed

‎README.md‎

Lines changed: 290 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,291 @@
1-
# Addchat Laravel Lite API
1+
# Introduction
22

3-
This is API for addchat vuejs lite app
3+
Welcome to AddChat Laravel Lite.
4+
5+
---
6+
7+
#### Read the documentation live - [AddChat Laravel Lite Docs](https://addchat-docs.classiebit.com)
8+
9+
#### Live Preview - [AddChat Laravel Lite](https://addchat-laravel.classiebit.com)
10+
11+
---
12+
13+
![AddChat Lite - Laravel Chat Widget](https://addchat-docs.classiebit.com/images/addchat-docs-banner-1.jpg "AddChat Lite - Laravel Chat Widget")
14+
15+
---
16+
17+
> **Here's a complete video tutorial guide for getting started quickly [AddChat Laravel Academy](https://classiebit.com/academy/addchat-laravel/getting-started) ✌️**
18+
19+
---
20+
21+
### All-in-one multi-purpose Chat Widget Laravel Pacakge
22+
23+
AddChat is a new chatting friend of Laravel. It's a standalone Chat widget that uses the website's existing `users` base, and let website users chat with each other.
24+
25+
<br>
26+
27+
You get full source-code, hence AddChat lives and runs on your server/hosting including database. And therefore, you get complete privacy over your data. Either you're a big corporate sector or a small business. AddChat is for everyone.
28+
29+
30+
## Overview
31+
32+
**Addchat Lite** is a chat widget that you can integrate into an existing or a fresh Laravel website. AddChat works like a standalone widget and fulfills all your business-related needs like -
33+
34+
1. User-to-user chatting
35+
2. Live real-time chatting (without page refresh)
36+
3. **Internal** notification system (saves **Pusher** monthly subscription fees)
37+
4. Customer support (<larecipe-badge type="black" circle icon="fa fa-lock"></larecipe-badge> Pro)
38+
5. Multi-user groups (<larecipe-badge type="black" circle icon="fa fa-lock"></larecipe-badge> Pro)
39+
40+
and a lot more features coming up in **AddChat Pro** ⚡️
41+
42+
43+
## Why AddChat ?
44+
45+
Some of the key highlights, why you would like to go with AddChat!
46+
47+
- Save monthly subscription bills (pay once use forever)
48+
- No Confidential Data leak
49+
- Complete Privacy
50+
- Easy to install & update
51+
- Use existing users database
52+
- Multi-purpose, use it as Helpdesk, Customer support, User-to-user chatting and much more...
53+
54+
---
55+
56+
> **AddChat never modifies your existing database tables or records. And it never breaks down any of your website functionality.**
57+
58+
---
59+
60+
> **AddChat is fully tested and ready to be used in production websites.**
61+
62+
---
63+
64+
65+
## Technical Specification
66+
67+
AddChat is very light, high performance, scalable and secure.
68+
69+
1. AddChat front-end built with **VueJs**, which is purely API based web-app.
70+
71+
2. AddChat back-end (API) built with **Laravel**
72+
73+
- **AddChat Laravel** version is a Laravel package, hence, can be installed via **Composer** in an existing or a fresh Laravel website.
74+
75+
76+
77+
## User Interface & Design
78+
79+
AddChat is designed in **CSS Flexbox** and **Sass**. Let's see what's so special about **CSS Flexbox** and why we used it.
80+
81+
1. AddChat is a CSS Framework Independent. Means, no matter in which CSS Framework your website is in, it neither affects the website CSS nor gets affected by it.
82+
83+
- [Bootstrap](https://getbootstrap.com/)
84+
- [Bulma](https://bulma.io/)
85+
- [Materializecss](https://materializecss.com/)
86+
- [Semantic UI](https://semantic-ui.com/)
87+
- [UIKit](https://getuikit.com/)
88+
- [Zurb Foundation](https://foundation.zurb.com/)
89+
90+
or any other...
91+
92+
2. AddChat CSS is completely encapsulated (wrapped in AddChat wrapper with `#addchat-bot .c-` prefix).
93+
- Hence, it never override your website CSS nor inherits from it.
94+
95+
- AddChat UI is extra-responsive. Optimized for **extra-small** devices to large **4K desktops** -
96+
97+
* Small phones
98+
* Android Phones
99+
* iPhones
100+
* iPad & iPad Pro0
101+
* Small-Medium Size Laptops
102+
* Large Desktops
103+
104+
3. We've used the popular **NPM** package `auto-prefixer` to make the AddChat UI design same across all types of browsers e.g `Chrome, Firefox, Safari, Edge` etc
105+
106+
107+
108+
## Multi-regional
109+
110+
AddChat is compatible with all languages and timezones. AddChat auto adapts and adjust website's default timezone and language. Please refer to the Language section for more info about **adding a new language** in [AddChat Laravel](/{{route}}/{{version}}/admin/multi-language-laravel)
111+
112+
---
113+
114+
> **AddChat never breaks any of your website functionality, even if something went wrong with AddChat, there are `fallback modes` for every worst-case scenario.**
115+
116+
---
117+
118+
119+
## Lite Version
120+
121+
---
122+
123+
> **This is AddChat Lite version documentation**
124+
125+
---
126+
127+
128+
**AddChat Lite** is open-source, free to use. Lite version has got limited features & functionality.
129+
130+
- **AddChat Laravel Lite**
131+
132+
+ [Live](https://addchat-laravel.classiebit.com) - Visit live.
133+
+ [Github](https://github.com/classiebit/addchat-laravel) - Give us a Star.
134+
+ [Install](https://classiebit.com/addchat-laravel) - Visit here to install
135+
136+
137+
## Pro Version
138+
139+
**AddChat Pro Version** comes with **Commercial** license. Pro version is fully loaded with a lot of useful and exciting features.
140+
141+
- **AddChat Laravel Pro**
142+
143+
+ [Live](https://addchat-laravel-pro.classiebit.com) - Coming soon
144+
+ [Purchase](https://classiebit.com/addchat-laravel-pro) - Subscribe now for notifications, will be soon available for Purchase here
145+
146+
147+
---
148+
149+
# Laravel Installation
150+
151+
AddChat can be installed via composer. Smooth... 🍻
152+
153+
---
154+
155+
> **Here's a complete video tutorial guide for getting started quickly [AddChat Laravel Academy](https://classiebit.com/academy/addchat-laravel/getting-started) ✌️**
156+
157+
---
158+
159+
160+
### Prerequisites
161+
162+
* Laravel version 5.5 / 5.6 / 5.7 / 5.8 / 6.x
163+
* Make sure to install AddChat package on a **Fresh** or **Existing** Laravel application.
164+
* We also assume that you've setup the database.
165+
* If you're running MySql version older than < 5.7 then disable strict mode in Laravel `config/database.php` `'strict' => false`
166+
167+
168+
### Install
169+
170+
1. If installing AddChat on an existing Laravel application and you already have **Auth** system then **skip this step**
171+
172+
If installing on a **Fresh Laravel application** then run
173+
174+
**For Laravel 5.5 to 5.8**
175+
176+
```php
177+
php artisan make:auth
178+
179+
php artisan migrate
180+
```
181+
182+
**For Laravel 6.x**
183+
184+
```php
185+
composer require laravel/ui --dev
186+
187+
php artisan ui vue --auth
188+
189+
npm install && npm run dev
190+
191+
php artisan migrate
192+
```
193+
194+
2. Install AddChat via Composer
195+
196+
```php
197+
composer require classiebit/addchat-laravel
198+
```
199+
200+
3. Run AddChat install command
201+
202+
```php
203+
php artisan addchat:install
204+
```
205+
206+
4. Open the common layout file, mostly the common layout file is the file which contains the HTML & BODY tags.
207+
208+
- Copy AddChat CSS code and paste it right before closing **&lt;/head&gt;** tag
209+
210+
```php
211+
<!-- 1. Addchat css -->
212+
<link href="<?php echo asset('assets/addchat/css/addchat.min.css') ?>" rel="stylesheet">
213+
```
214+
215+
- Copy AddChat Widget code and paste it right after opening **&lt;body&gt;** tag
216+
217+
```php
218+
<!-- 2. AddChat widget -->
219+
<div id="addchat_app"
220+
data-baseurl="<?php echo url('') ?>"
221+
data-csrfname="<?php echo 'X-CSRF-Token' ?>"
222+
data-csrftoken="<?php echo csrf_token() ?>"
223+
></div>
224+
```
225+
226+
- Copy AddChat JS code and paste it right before closing **&lt;/body&gt;** tag
227+
228+
```php
229+
<!-- 3. AddChat JS -->
230+
<!-- Modern browsers -->
231+
<script type="module" src="<?php echo asset('assets/addchat/js/addchat.min.js') ?>"></script>
232+
<!-- Fallback support for Older browsers -->
233+
<script nomodule src="<?php echo asset('assets/addchat/js/addchat-legacy.min.js') ?>"></script>
234+
```
235+
236+
>{warning} Please replace **&lt;php ?>** tag by **{{}}** curly brackets.
237+
238+
239+
#### The final layout will look something like this
240+
241+
```php
242+
<head>
243+
244+
<!-- **** your site other content **** -->
245+
246+
<!-- 1. Addchat css -->
247+
<link href="<?php echo asset('assets/addchat/css/addchat.min.css') ?>" rel="stylesheet">
248+
249+
</head>
250+
<body>
251+
252+
<!-- 2. AddChat widget -->
253+
<div id="addchat_app"
254+
data-baseurl="<?php echo url('') ?>"
255+
data-csrfname="<?php echo 'X-CSRF-Token' ?>"
256+
data-csrftoken="<?php echo csrf_token() ?>"
257+
></div>
258+
259+
260+
261+
<!-- **** your site other content **** -->
262+
263+
264+
265+
<!-- 3. AddChat JS -->
266+
<!-- 3. AddChat JS -->
267+
<!-- Modern browsers -->
268+
<script type="module" src="<?php echo asset('assets/addchat/js/addchat.min.js') ?>"></script>
269+
<!-- Fallback support for Older browsers -->
270+
<script nomodule src="<?php echo asset('assets/addchat/js/addchat-legacy.min.js') ?>"></script>
271+
272+
</body>
273+
```
274+
275+
---
276+
277+
> **For Info, the `php artisan addchat:install` publishes AddChat assets to your application `public/assets` directory**
278+
279+
---
280+
281+
> **`addchat.min.js` for modern browsers & `addchat-legacy.min.js` for older browsers. These will be used switched by the browsers automatically on the basis on `type="module"` & `nomodule`, you need to nothing.**
282+
283+
---
284+
285+
> **Setup finishes here, now heads-up straight to [Settings](/{{route}}/{{version}}/admin/settings) docs**
286+
287+
---
288+
289+
#### Must read the documentation for getting started - [AddChat Laravel Lite Docs](https://addchat-docs.classiebit.com)
290+
291+
---

‎src/AddchatServiceProvider.php‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,6 @@ private function registerPublishableResources()
6565
'resources' => [
6666
"{$publishablePath}/lang" => resource_path('lang/vendor/addchat')
6767
],
68-
'storage' => [
69-
"{$publishablePath}/dummy_content/" => storage_path('app/public')
70-
],
7168
'public' => [
7269
"{$publishablePath}/assets" => public_path('assets'),
7370
],

‎src/Commands/InstallCommand.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public function handle(Filesystem $filesystem)
6868
$this->info('Initiate the installation process...');
6969

7070
// 1. Publish the core assets defined in the AddchatServiceProvider
71-
$this->info('1. Publishing Addchat core assets: config, languages & dummy content');
71+
$this->info('1. Publishing Addchat core assets: config & languages');
7272
$this->call('vendor:publish', ['--provider' => AddchatServiceProvider::class]);
7373

7474
// 2. Run Addchat migrations

0 commit comments

Comments
 (0)