Skip to content
A synchronized to-do app built with Laravel, Vue, and laravel-websockets
PHP HTML Vue
Branch: master
Clone or download
Latest commit 0f98f80 Jul 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Adds a delete option to each list item Jul 6, 2019
bootstrap Initial commit Jun 22, 2019
config
database Initial commit Jun 22, 2019
public Adds README Jul 7, 2019
resources Adds README Jul 7, 2019
routes Adds a delete option to each list item Jul 6, 2019
storage Initial commit Jun 22, 2019
tests Initial commit Jun 22, 2019
.editorconfig Initial commit Jun 22, 2019
.env.example
.gitattributes Initial commit Jun 22, 2019
.gitignore Adds landing site initial design, mockup, and styles. Removes DS_Stor… Jul 1, 2019
.styleci.yml Initial commit Jun 22, 2019
artisan Initial commit Jun 22, 2019
composer.json Initial commit Jun 22, 2019
composer.lock Initial commit Jun 22, 2019
package-lock.json Initial commit Jun 22, 2019
package.json Initial commit Jun 22, 2019
phpunit.xml Initial commit Jun 22, 2019
readme.md Adds README Jul 7, 2019
server.php Initial commit Jun 22, 2019
webpack.mix.js Adds a delete option to each list item Jul 6, 2019
yarn.lock Initial commit Jun 22, 2019

readme.md

About

ListPal is a web app that lets you create easily shareable to-do lists that automatically stay in sync and display updates in real time. It's currently powered by:

This repo is currently what powers the main app at listpal.co. You can also choose to clone this repository and run on your own server by following the steps below.

Prerequisites

This app is currently powered by Laravel 5.8, and as such follows their requirements for proper installation. Your server will need to meet the following conditions:

  • PHP >= 7.1.3
  • BCMath PHP Extension
  • Ctype PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension

In addition to the above, if you'll be modifying any styles or JavaScript, you will need to have both Node.js and NPM installed (preferably with their latest up-to-date versions).

Installation

After cloning this repo to your desired location, complete the following steps:

  • Run composer install.
  • Run npm install.
  • Copy .env.example to .env and add in your database and app name details.
  • Run php artisan migrate to add in the database structure.
  • Run php artisan websockets:serve to start the laravel-websockets server.
  • Visit the website!

Compiling Assets

If you make any modifications to the styles, images, or JavaScript in the /assets/ directory, you'll need to recompile them through Laravel's Mix webpack wrapper. From the root directory, simply run either:

  • npm run dev for fast compilation during local development
  • npm run production to minify and transpile assets for production deployment

Contributing

ListPal is still very much in active development, and as such bugs and feature requests might be pretty common. If you'd like to contribute to the app's development, please feel free to open a pull request resolving an issue or adding in a requested feature!

Contact Info

If you have any questions or concerns, you can reach out directly via Twitter or through email.

License

ListPal is open-source software licensed under the MIT license.

You can’t perform that action at this time.