jeffreyway / council

An open source forum built on Laravel.

Council

This is an open source forum that was built and maintained at Laracasts.com.

Installation

Prerequisites

• To run this project, you must have PHP 7 installed.
• You should setup a host on your web server for your local domain. For this you could also configure Laravel Homestead or Valet.
• If you want use Redis as your cache driver you need to install the Redis Server. You can either use homebrew on a Mac or compile from source (https://redis.io/topics/quickstart).

Step 1

Begin by cloning this repository to your machine, and installing all Composer & NPM dependencies.

git clone [email protected]:JeffreyWay/council.git
cd council && composer install && npm install
php artisan council:install
npm run dev

Step 2

Next, boot up a server and visit your forum. If using a tool like Laravel Valet, of course the URL will default to http://council.test.

1. Visit: http://council.test/register to register a new forum account.
2. Edit config/council.php, and add any email address that should be marked as an administrator.
3. Visit: http://council.test/admin/channels to seed your forum with one or more channels.

council's Issues

Call seed on migrating the database

There is no command provided to use the database seeder.

It's good practice to do that within the php artisan migrate --seed

Add a license.md file

Its good practice to add LICENSE.md file to the project.

Click the new file button in the repository and name the file LICENSE.md click the choice a license from template button. Choose a license guide

Theme Proposal

It would be good if entire authentication system scaffolding was via AJAX like Laracasts

composer.lock is out of date

composer.lock is not up to date and doesn't contain stevebauman/purify package, so you need to execute composer update instead just of composer install

Feature: add "reputation" support.

It would be nice if users accrue "reputation" points as they participate in the forum.

1. Create a thread: 10 points
2. Leave a reply: 2 points
3. Reply is marked as "best reply" - 50 points
4. Reply was liked: 4 points

Fix small type error in DatabaseSeeder class

After installing the project, when trying to seed the database I notice a small type error.

In DatabaseSeeder.php line 16:

Parse error: syntax error, unexpected '->' (T_OBJECT_OPERATOR)

disableExceptionHandling change.

on TestCase disableExceptionHandling can be replace

// Hat tip, @adamwathan.
protected function disableExceptionHandling()
{
        $this->oldExceptionHandler = $this->app->make(ExceptionHandler::class);
        $this->app->instance(ExceptionHandler::class, new class extends Handler {
            public function __construct() {}
            public function report(\Exception $e) {}
            public function render($request, \Exception $e) {
                throw $e;
            }
       });
}

to

// Hat tip, @adamwathan.
protected function disableExceptionHandling()
{
        $this->oldExceptionHandler = $this->app->make(ExceptionHandler::class);
        $this->app->instance(ExceptionHandler::class, new \App\Exceptions\Handler($this->app));
}

for me it worked normally. please test, comments what you guys think?

New series?

I got my eye on you, @JeffreyWay haha

Thanks for all the great content you work on. I smell a new series coming up.

Add cache:clear to the install command

Sometimes when you install the forum you end up with some dirt on cache.
I think it will be cool if the command council:install clear the cache just to make sure everything is reseted.

Users can reply without account confirmation

Users can successfully post a new reply without having their account confirmed.

Still not sure if it's intended or not, but I think this shouldn't be allowed :)

Ask for Database port number in installation process

I have running MySQL on different port, so the installation process fails during migration.

Missing readme steps for database setup and migration

For new installs, your readme looks to be missing an important note in step 2 for setting up the initial database migration. :)

php artisan migrate

Cheers!
David

Attachment feature

Nice to have a attachment for thread and user can upload files

Failing test (Tests\Console\InstallCommandTest::it_optionally_migrates_the_database)

Not quite sure what's going on here..

➜  council git:(master) phpunit
PHPUnit 6.5.5 by Sebastian Bergmann and contributors.

..E...................S........................................  63 / 103 ( 61%)
........S...............................                        103 / 103 (100%)

Time: 10.39 seconds, Memory: 34.00MB

There was 1 error:

1) Tests\Console\InstallCommandTest::it_optionally_migrates_the_database
Mockery\Exception\NoMatchingExpectationException: No matching handler found for Mockery_0_App_Console_Commands_InstallCommand::call("cache:clear"). Either the method was unexpected or its arguments matched no expected argument list for this method



/Users/dframe/Projects/Deframe/council/vendor/mockery/mockery/library/Mockery/ExpectationDirector.php:93
/Users/dframe/Projects/Deframe/council/app/Console/Commands/InstallCommand.php:48
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:29
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:87
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php:31
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Container/Container.php:549
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Console/Command.php:183
/Users/dframe/Projects/Deframe/council/vendor/symfony/console/Command/Command.php:252
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Console/Command.php:170
/Users/dframe/Projects/Deframe/council/vendor/symfony/console/Application.php:936
/Users/dframe/Projects/Deframe/council/vendor/symfony/console/Application.php:240
/Users/dframe/Projects/Deframe/council/vendor/symfony/console/Application.php:148
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Console/Application.php:88
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Console/Application.php:177
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php:249
/Users/dframe/Projects/Deframe/council/vendor/laravel/framework/src/Illuminate/Foundation/Testing/Concerns/InteractsWithConsole.php:18
/Users/dframe/Projects/Deframe/council/tests/Console/InstallCommandTest.php:56
/Users/dframe/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:195
/Users/dframe/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:148

ERRORS!
Tests: 103, Assertions: 187, Errors: 1, Skipped: 2.

Syntax Highlighting for Code Blocks

Syntax highlighting for various languages for thread bodies and replies

[Admin] User administration panel

Maybe with ban and/or account suspension system?

Missing named routes

Maybe we should add more named routes for coherency and simplicity? :)

Test failure: AlgoliaSearch requires an applicationID

The a_user_can_search_threads test fails owing to the lack of valid Algolia credentials.

Add CONTRIBUTING.md

It's good practice to add a CONTRIBUTING.md explaining the best ways for another person to contribute to your project. Here is a good example of one.

Redirect to the /threads route after login or register.

Currently after a user logins or registers, they are redirected to the /home route.

Point rewarded and reduced on favorite could be wrong

If i’m not mistaken the points on the favoritable class should be rewarded (and reduced) to the owner of the reply not to the authenticated user.

Empty public folder of asset files

We should also then add further instructions to the readme of how to generate them

Receiving real time notification without refreshing the page

Feature Request: Add Travis CI to check if Tests are green

Hi,

it would be nice if we can see the test status within a badge in the readme.md.

Instant username autocompletion broken

It seems switching to trix has broken instant username autocompletion.

Redirect the home "/" route to "/threads"

I think it will be nice if when the user access the root "/" route, he is redirected to to the threads page.

.dev domain issue in chrome

Hi,
I know you usually use foo.dev for a local development project
Unfortunately chrome forces all .dev to redirect to https, As I understand the gTLD .dev is registered by google and for some reason they have codded this into chrome.
If you don't have https setup for your local development, you cannot use .dev

Install command not working as intended

There seems to be an issue with running migrations when prompted by the install command. This is the error I get when trying to do a fresh install:

SQLSTATE[HY000] [1044] Access denied for user ''@'localhost' to database 'forge' (SQL: select * from information_schema.tables where table_schema = forge and table_name = mi
grations)

Steps to reproduce
Clone the repo and follow installation instructions from README.
When prompted with the question whether you want to migrate the database, enter yes.

Summary

1. In the fresh installation process you get to run php artisan council:install.
2. At that point there's no .env file.
3. As the install command gets triggered, you get prompted for database credentials.
   Regardless of what you type in, at that point the application was already bootstrapped, so the database credentials got stored to .env file but never picked up by the application instance.

If you re-run install command after seeing that error (and even provide invalid data this time), the migrations will work because .env file exists at the boot time.
That means the application instance will load up with correct environment variables, the migrations will be ran successfully, and the .env file will get populated with invalid data.

Create thread form shouldn't display

If your email address isn't yet confirmed, you shouldn't be able to visit the page to create a new thread. This is annoying.

Error while subscribing to thread.

When i subscribe to thread, it gives me console error.

Avoid mutating a prop directly since the value will be overwritten whenever the parent component re-renders. Instead, use a data or computed property based on the prop's value. Prop being mutated: "active"

Awarding "favorite" reputation to wrong user??

Isn't this incorrect; if I am signed in and favorite a reply by @JeffreyWay, then he should get the points, not me!

council/app/Favoritable.php

Line 39 in 5041b53

Reputation::award(auth()->user(), Reputation::REPLY_FAVORITED);

Admin Panel Edit/Remove Channel

Would be nice to add the function to edit/remove a channel.

Maybe we should think of a better way to handle administrators

Having their emails listed in a config file is ok to bootstrap things, but not good enough to stay there much longer :)

Tbh, I think a forum will need - at some point - a real roles system, but at first maybe we could add the isAdmin column directly to the users and make the user create him during the installation process.

Recaptcha Test Keys causes failing test

The a_thread_requires_recaptcha_verification test is failing since the reCaptcha test keys have been used - they always return a positive response:

With the following test keys, you will always get No CAPTCHA and all verification requests will pass.

Our tests expect verification to fail.

We could happy path the test, and assert that the thread was created?

How to exclude robots and google spider page requests from thread visits count

Currently any non-human visitors hitting the url cause an increment to happen for thread visits statistics.
which can create fake stats.

ThreadsController@show
$thread->increment('visits'); #

Default seeders instead of tinkering

We think that much easier is just execute php artisan db:seed instead of tinkering and generating fake channels and threads every time we need clean slate.

Spam detected for code

When creating a new thread spam detection is triggered when posting code

Example code that triggers spam

public function index() { return view('home'); }

Posting this code when editing a thread does not trigger spam detection

Theme Proposal

I've done a few projects recently and utilized Vuetify. It's quite flexible and looks nice too. I would like to open a pull request to begin incorporating that theme into this project if others also agree this would be a good approach to take.

Step 2 is missing the migration

THere arent any instructions to do the migration, it should be in step 2 after you set your DB config.

Reverse instead of Reduce

In Lesson 8 Jeffrey uses the term reduce a user deletes a thread or a reply to lower the users reputation.

I would refer to these as transactions. Thus when a user deleted a thread or reply we should 'reverse' the reputation transaction related to the thread or reply

Adding some issue/PR templates

GitHub supports adding issue and/or PR templates to pre-populate some things. This can ve very useful when you want to get extra info in issues, or ensure PRs have the quality the project has, or add tests, etc. As an example of an open-source project, we should add this templates.

Roadmap (Suggestion)

Since this is both open source project and video series on Laracast it could be opportune to include a roadmap either in the readme or in a new file.

This roadmap could include ideas you have or things you like to work on down the road and also mentioned if you want to do them yourself as a video on Laracast or have the community involved. This would also focus feature request PR's towards what you have in mind as the progression of Council.

If you prefer to use github issues maybe label issues with milestones and assign features you want to include as part of a video to yourself. While features you want the community to make, can be labeled with Help wanted.

[Installation] Make all DB credentials configurable inside counci:install command

The title is pretty much self-explanatory.
At this point, we should probably wait to see if PR #100 gets merged, and after that add configuration steps for every single database credential :)

Wysiwyg editor is not cleared after second reply

When user replies to the same thread (without refreshing browser), editor's content hasn't cleared like after first time.

User Profile Activities displaying escaped HTML tags

On the user's profile page, the activities are displaying escaped HTML tags.

Add Hash::setRounds(4) to CreatesApplication trait

This is now standard Laravel and should speed up the tests once they are all passing.

[Discussion] Moving reputation points to council.php config file?

I think it would be easier and more logic for the average user to have all the configurable data in the same place.

@JeffreyWay and everyone else: how do you feel about it? Does this approach have any real downside?

Use `squash` merge instead of normal merge

When you are merging PR and have more than one commit (merge commit is also a separated commit), then history of repo will be a lot more cleaner than now, when every PR is duplicated in Git's history.

Error "key was too long" while migrating

On MySQL database server older than 5.7.7 php artisan migrate generates error "key was too long".

To solve this you need to add line: \Schema::defaultStringLength(191); to AppServiceProvider@boot.

Connection refused [tcp://127.0.0.1:6379]

where this issue comming from ?