A todo list application. This project began as an exercise in learning to use Inertia.js(along with CakePHP Adapter), React and CakePHP together, and to try a new approach to CSS. Heavily inspired in functionality and design by Todoist and Things.

This project is great if you want to host and operate your personal todo lists in your personal cloud, where you know exactly what is being done with your data.

1. Clone this repository.
2. Download Composer or update composer self-update.
3. Ensure you have a nodejs environment with yarn.
4. Install dependencies:

   php composer.phar install
   yarn install
   

You're now ready to build the assets:

yarn dev

Next setup your database configuration in config/app_local.php. Docket is tested against MySQL, Postgres and SQLite. Then run migrations:

bin/cake migrations migrate

You can now serve Docket using either the built-in PHP webserver, or more robust webserver like Apache or Nginx.

To use the built-in PHP server run:

bin/cake server -p 8765

Then visit http://localhost:8765 to see the landing page, and create your account.

While you shouldn't need to configure much, if you do want to tweak settings, the config/app_local.php file is where you should make any changes specific to your setup. During application start, this file is loaded and merged onto the defaults in config/app.php.

Server tests can be run via phpunit. By default only the functional and integration tests are run. Docket also uses panther to do automated browser testing. Running acceptance tests requires you to have a browser driver available. Follow the installation guide in panther to get started. Once you have a driver installed acceptance tests can be run using phpunit:

phpunit --testsuite=acceptance

Javascript tests can be run via jest:

yarn test