rogerpro/clearstep

A way to organize your tasks.

1.0.0 2017-12-27 17:54 UTC

Requires

• php: >=5.6
• cakedc/users: ^5.0
• cakephp/cakephp: ^3.4
• cakephp/migrations: @stable
• cakephp/plugin-installer: *
• mobiledetect/mobiledetectlib: 2.*

Requires (Dev)

• cakephp/bake: ~1.1
• cakephp/debug_kit: ~3.2
• phpunit/phpunit: ^5.7|^6.0
• psy/psysh: @stable

Suggests

• cakephp/cakephp-codesniffer: Allows to check the code against the coding standards used in CakePHP.
• markstory/asset_compress: An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.
• phpunit/phpunit: Allows automated tests to be run without system-wide install.

MIT

README

A web app to help you organizing your client/provider & your own tasks. Made with CakePHP 3.

• Both for professional & personal tasks, as a TO DO list.
• Set deadlines, tags & comments for your pending tasks using tickets.
• Log your working/whatever sessions and link them with your tickets (or just keep them standalone).
• Get app & email alerts when something happens (new ticket, changed ticket, deadline approaching, overtime dedicated to a project, etc).

Great to be installed as an extranet webapp.

Installation

The recommended way to install ClearStep is with Composer:

composer create-project rogerpro/clearstep

You should now be able to visit the path to where you installed the app and see the home page.

Configuration

You need a SQL database and a LAMP (or similar) installation to run the app. Check the CakePHP Cookbook to know the exact requirements.

Read and edit config/app.php and setup the 'Datasources' and any other configuration relevant for your application.

Almost done: populating the database

From the root directory of the app, run:

bin/cake migrations migrate

At this moment, you will have an app with the minimum data required on the database.

Last step: creating your users

There's a default admin user at this time. Use it to log in.

Username: temporary Password: 123456

Once logged in, I recommend you to create a new admin with a new password. Log in with it, an then remove the original temporary user for security reasons.

Where to start

Start creating a new project (clic 'New Project' on the left menu').

Then, you can log your first working session

Update

To update the application, just run, from the app root:

composer update

Layout

The app uses a subset of Foundation CSS framework by default. You can, however, replace it with any other library or custom styles.

What's done (try it now!)

• Log of working sessions, registering:
  • When did they start
  • When did they ended
  • Total duration
  • Project
  • Related ticket
  • Task description
• Management of:
  • Clients
  • Projects
  • Sessions
• Summaries:
  • Today's detail
  • Today's summary
  • Today's total
• Multiclient
• Multiproject
• i18n (Internationalization) ready (current literals in English)

What's coming (TO DO list)

• Management of:
  • Tickets
  • Users
  • Budgets
  • Fiscal data
  • Invoices
  • Financial transactions
• Summaries & statistics (big data):
  • Average & total time
    • per client
    • per project
  • Most productive
    • working hours
    • working days
  • Average ticket resolution time
• Automatic email sending
• Alerts:
  • Expected time reached per client, project, etc.
  • Maximum client credit reached
  • Discontinued project
• Invoice generation (PDF)
• Multiuser
• Multicountry
• Multicurrency
• L10n (localization)
• Export tickets with deadline to calendar app formats (Google, Apple, Outlook, etc)

Contributing

Feel free to share what would you like ClearStep to do with an issue or directly with a PR. You can also write me directly via email.

License

Copyright 2017 Roger Campanera. All rights reserved.

Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.