PHP Vue JavaScript HTML
Latest commit 53fe13f Jan 22, 2018 @sullyfischer sullyfischer a temporary fix
Permalink
Failed to load latest commit information.
.vscode Upgrade messaging style Oct 5, 2017
app merge Jan 22, 2018
bootstrap first commit May 22, 2017
config merge Jan 22, 2018
database sync clientside settings with the cloud Jan 19, 2018
dist Save latest chantes Nov 7, 2017
public a temporary fix Jan 22, 2018
resources a temporary fix Jan 22, 2018
routes fix a big where reload on pages would redirect guest to login page Jan 21, 2018
storage first commit May 22, 2017
tests SPA pages Dec 28, 2017
.env.dusk.testing improve authintication pages Jan 7, 2018
.env.example merge Jan 22, 2018
.eslintrc.js Upgrade messaging style Oct 5, 2017
.gitattributes first commit May 22, 2017
.gitignore Use computed with setters instead of watch Nov 29, 2017
.phpstorm.meta.php Update Laravel to 5.5.3 Sep 13, 2017
LICENSE.txt first commit May 22, 2017
_ide_helper.php Apply fixes from StyleCI Sep 19, 2017
_ide_helper_models.php replace "karma" with "xp" Jan 1, 2018
artisan first commit May 22, 2017
circle.yml Add redis as a service because of hard coded dependencies so far Aug 29, 2017
composer.json Improve test units Sep 10, 2017
composer.lock Update Laravel to 5.5.3 Sep 13, 2017
package-lock.json use markdown-it plugin Jan 20, 2018
package.json use markdown-it plugin Jan 20, 2018
phpunit.dusk.xml Add default dusk phpunit file Aug 29, 2017
phpunit.xml Change to use sqlite for testing Sep 5, 2017
readme.md Update readme.md Oct 22, 2017
server.php Apply fixes from StyleCI May 22, 2017
webpack.mix.js remove plugins using jQuery and jQuery itself Jan 14, 2018
yarn.lock Latest Cleanups Jan 14, 2018

readme.md

Voten.co

Voten.co is a real-time social bookmarking for the 21st century. It's real-time, beautiful, customizable yet simple. To get a quick taste of what Voten is written with please check our credits page.

Contributing

Thank you for considering contributing to the Voten. To encourage active collaboration, Voten strongly encourages pull requests, not just bug reports. Voten's Slack channel is created for developers to discuss Voten development concerns. If you have an idea (and not the code for it) you may contact us either with the info@voten.co email address or submit it to #votendev channel.

Coding Style

Voten follows the PSR-2 coding standard and the PSR-4 autoloading standard. Voten also uses StyleCI for automatically merging any style fixes. So you don't have to worry about your code style much.

Software Stack

Voten is a Laravel application that runs on the following software:

  • Ubuntu 16.04.2 LTS
  • Nginx 1.10+
  • MySQL 5.7+ (to use mariaDB, you must modify json type migration columns to blob by running sed -i 's/json(/binary(/g' * inside the database/migrations/ directory in Linux)
  • PHP 7.1+
  • Redis 3.0+
  • Git 2.8.4+
  • Pusher (we use laravel-echo-server on production server)
  • Algolia Search

To install all the required stack on a server, we recommend an auto-installation service such as CodePier.

Installation Steps

After cloning the repository, first create a .env from the example file:

cp .env.example .env

Open ".env" file with your desired editor and enter your services info. Now run below commands:

composer install
php artisan key:generate
php artisan migrate
php artisan passport:install
npm install
npm run production

Create admin user

To create an admin user, run the below command from the root of the project

php artisan db:seed --class=AdminUserSeeder

The login details for the admin user is admin and password.

After running the seeder, be sure to clear your redis cache, you should now be able to navigate to /backend

Security Vulnerabilities

If you discover any security vulnerability within Voten's source code, please send an e-mail to Sully Fischer at fischersully@gmail.com instead of opening an issue. All security vulnerabilities will be promptly addressed.

API

A public API is the next step of Voten's development. In the meanwhile, if you're interested in developing applications on top of our API please contact us at info@voten.co.