rogerpro/clearstep

A way to organize your tasks.

ClearStep

A web app to help you organizing your client/provider & your own tasks. Made with CakePHP 3., _(*1)

• 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., _(*2)

Installation

The recommended way to install ClearStep is with Composer:, _(*3)

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., _(*4)

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., _(*5)

Read and edit config/app.php and setup the 'Datasources' and any other configuration relevant for your application., _(*6)

Almost done: populating the database

From the root directory of the app, run:, _(*7)

bin/cake migrations migrate

At this moment, you will have an app with the minimum data required on the database., _(*8)

Last step: creating your users

There's a default admin user at this time. Use it to log in., _(*9)

Username: temporary Password: 123456, _(*10)

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., _(*11)

Where to start

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

Then, you can log your first working session, _(*13)

Update

To update the application, just run, from the app root:, _(*14)

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., _(*15)

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., _(*16)

License

Copyright 2017 Roger Campanera. All rights reserved., _(*17)

Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file., _(*18)