
BREAK
About a project
Forum with Laravel 8, Livewire, Alpine.js & Tailwind CSS.
Features list
- filter threads (ex. most replies, unanswered, author, channel)
- create/edit/delete replies to a thread
- like/unlike a reply
- activity feed for a user (ex. created a thread, replied to a thread, liked/unliked a reply)
- thread subscription (creating a reply notifies subscribers)
- notification bell lists only unique links
- visiting a thread creates cache key to show updated threads to user
- spam detection on user inputs
- user cannot create replies or threads too frequently
- delete button with confirm action (Livewire & Alpine.js)
- state-button component (for ex. liking/disliking, subscribing)
- mention '@' users in messages (creates notification)
- thread visits count
- trending threads sidebar (Redis)
- create thread w/ modal
- responsive design (Tailwind CSS)
- best reply functionality
- thread can be locked by an admin
- instant search bar - title & body (Livewire)
- sanitizing user inputs (Purify)
- username autocomplete in messages (Tribute)
- trending threads only from past day (Redis)
To-do list
How to setup a Laravel project from github repository
- Download .zip file from a given github repository.
- Unpack .zip file and move terminal working location to the project folder.
- Run commands:
- composer install
- npm install && npm run dev
- Copy .env.example file and rename it to .env file (projects' main folder).
- Generate an app encryption key:
- php artisan key:generate
- (it should update an APP_KEY value in you .env file)
- Create an empty database for a project (recommended coalition: utfmb4_unicode_ci).
- Add database information in .env file:
- DB_HOST
- DB_PORT
- DB_DATABASE
- DB_USERNAME
- DB_PASSWORD
- Migrate the database:
- php artisan migrate
- (it will create all necessary tables to run an application)
- Seed the database:
- php artisan db:seed
- (located in /database/seeders, it will populate the database with test data)
- [Optional] How to start Laravel development server:
- php artisan serve
- (check created URL with APP_URL value in .env file)
MIT License
Copyright (c) 2020 adrian-web
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.