Skip to content

MontealegreLuis/readit

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ReadIt

Build Status SensioLabsInsight

This is a lightweight clone of Reddit written in Laravel 5. It only has the following features:

  • User registration.
  • User authentication.
  • Registered users are called "Readitors" and they are allowed to post links to the site.
  • All users are allowed to see all the links posted by all readitors.
  • Only readitors are allowed to upvote and downvote links.
  • Readitors can toggle their votes on links at any moment.
  • Readitors can also cancel their votes at any moment.
  • Links are ranked by votes, most voted links appear at the top.
  • Links decrease their rank as time goes by, in order to allow new links to be at the top.
  • Every 5 minutes a link decay its rank by one point. A day has 1440 minutes, then any link loose 288 points daily (1440/5). If a link was posted yesterday, and it has 300 points at this moment, its current rank would be 12 (300 - 288).

Setup

In order to run this application locally, you'll need PHP 5.6, MySQL 5.6, and a global installation of Composer.

  1. Create your .env file, and edit it with your database development values.

    $ cp .env.example .env
  2. Install the application.

    $ source .env
    $ make install RUSER="root" RPSWD="root" HOST=$DB_HOST DB=$DB_DATABASE USER=DB_USERNAME PSWD=DB_PASSWORD

    Where the values of RUSER and RPSWD are the credentials of a user with permissions to create databases and users.

  3. Run the application

    $ php artisan serve
  4. Browse to http://localhost:8000/

Tests

Configure

In order to run the tests you should create a database with the following command. And run the migrations for that database.

make database RUSER="root" RPSWD="root" HOST="localhost" DB="homestead_test" USER="homestead" PSWD="secret"
php artisan migrate --database="testing"

RUSER and RPSWD are the credentials of a user with permissions to create databases and users. This configuration is also used by Travis.

Execute

Features are described using phpspec and there are some integration tests with PHPUnit.

$ bin/phpspec run
$ bin/phpunit --testdox

TODOs

There is room for improvement. This is my first Laravel application, so bear with me.

  • Ajax calls to vote a link should be sent through post.
  • Javascript code needs to be decoupled and tested.
  • CSS and Javascript assets should be managed with Gulp and Elixir.
  • There should be some more tests and specs.
  • There's no code for the case where a guest user tries to vote for a link.
  • Password management is not configured.
  • There's no captcha to post a links.
  • Subreadits

Those are the ones I can identify now.

About

Lightweight clone of Reddit

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages