TODO.md

TODOs

Crucial for MVP release

• also grep this repo for TODO within .py files and migrate them here

ASAP

• Invoices for fixed-rate projects don't work yet. The get_total_amount helper multiplies the fixed-rate with the amount of hours worked!
• Invoice: Must be able to set VAT rate (e.g. 0% for reverse charge or 19%)
• "fixed" projects (i.e. without hourly rate): Invoices and sessions don't make sense yet.
• show_which = invoiced or paid: The table in the reports doesn't make sense anymore if show_which != 'worked'
• Side_income needs export-csv views like Sessions has
• Plots should be per-year, but with the year selectable.
  • And behind the alpha-blue plots in grey: last year's earnings?
  • similarly with the linechart. Last year's line in grey?
• Die Pausezeiten werden nach einer Korrektur noch nicht berücksichtigt. Und der Vorschlagswert für den Tag einer Session sollte heute sein.
• Per-client report for time sheet generation to easily send monthly activity logs.
  • These should be per-project instead of per-client, but if you don't yet have multiple rates per project, this doesn't work :/
• Better reports:
  • Custom range report: If more months, align them next to each other with each month's sum at bottom (like Arc work log)
• Currently, my model doesn't allow to set multiple rates for one project (e.g. on-site and remote). I'd have to add a separate project for remote work.
  • Start a new git branch for this though
• (How to / Should I) add "passive" income?

Authentication

• Signup as a demo user: without e-mail required, and sample-data auto-installed.
• If you're not logged in, pull fixture session/project/users and use your request.session stuff to store the current setup. This is your demo user
  • => Read up on Django's session framework
• Or, just allow people to sign up without email
• Find out how to build a demo user who can:
  • be logged in by multiple people more than once
  • gets its own clients, sessions, etc. to play around, but after the session is done, this gets destroyed
    • This is not to restrict usage, but to allow curious people to play around without registering a "proper" account
    • Alternatively (or, additionally): Allow creation of users where data gets destroyed after 14 days
  • Or just leave it all open for the beginning

Testing

• Start with tests asap. Wait too long and it won't happen :)
• Then move to test-driven development
• Try PXP, maybe

Reports

• Pie chart of per-year earnings per client
• billable hours (convert days to 8 hours) worked per month/year
• Output reports as PDF
  • Use 'django-wkhtmltopdf' instead of reportlab, you can create and transform an invoice HTML easily instead of having to draw the whole PDF by hand
  • i.e., start with a HTML invoice
• Cashflow (i.e. money in bank, instead of money worked): Use the invoices' paid_date attribute instead of session dates
• Yearly overview
  • A table with columns year, month, $ worked, cashflow in, YTD $ worked
  • Maybe include a matplotlib/seaborn plot on that page?

Add/Edit session form

• Selecting the project should be hierarchical, by first selecting the client, then the project.
  • Ideally:
    • Select the client not from a dropdown, but from a one-click list
      • Then a conditional display of projects
• Behind "units worked", you should print the actual unit (day, hour, or fixed).
  • Problem: This depends on the client.
  • Maybe refactor UI so that you have to add a session from a project detail view (or as a button in the project list view)?
  • Or that AJAX/jQuery thing

General

• flake8 everything on a hangover day
• Unify language or add i18n
  • Why do I have a comma as decimal sign, not a period?
• All "delete" buttons should have a confirmation pop-up, or redirect to a dedicated confirmation template.
• The Session model should have functions units_worked() and money_earned() so that I can compute reports
  • Ideally: Never compute this redundantly. Currently, you are. (see reports/views.py:get_total_earned())
• The date in the ModelForms (i.e. on the frontend) should be shown as yyyy-mm-dd
• What happens if you try to delete a client, but it still has projects and/or sessions attached? (on_delete=PROTECT oder so)

Invoices App

• List unpaid invoices
• List overdue invoices
• Below the invoice pdf, as a second sheet maybe, add a list of all billed sessions
• How to fix sessions for a specific invoice? They should be non-mutable afterwards (or maybe only with a warning!)
  • Either add attribute 'invoiced' to a session, or with an m:n table of invoices:sessions
• How to ensure invoice no. uniqueness and continuity?
• Make a css with e.g. div class="A4invoice". It should span 21*29cm and have classes for the address, the footer, etc.
• Don't store the client ID in an invoice. Instead, put get_client() method in the invoice model
  • => you have to build a custom model validator for an invoice: all its assigned projects must belong to the same client
• In "add invoice", the form's client field is not really readonly, I can change it. The "disabled" attribute doesn't submit the client - what do? Keep it empty and add the client in Python instead?

Prettier

• Put Forms in tables at least :)
• Input field width narrower (4 digits year, e.g.)
• Dropdown menus (you need JavaScript for that)

Someday/Maybe

• Use django-tables2 instead of manually written HTML tables. They are also sortable by column
• Multiple currencies besides €

Really cool ideas

• Create an API that could allow logged-in users to download JSON of all their clients, projects, sessions, invoices, etc.
  • This would also allow you to build new products in a modular way instead of crumming everything report-y into HiredGun itself

AJAX/jQuery/etc

• Create invoice: Show the selectable sessions dynamically, first by from/to-date, by client -> project -> sessions
  • Ideally, live-update the invoice amount

Invoices

• I should make sure that a Session can only be billed in one Invoice. How? An extra table 'session_invoice' where constraint PK=(session, invoice)?
  • Or: Validate on storing an invoice that the timespan and project list don't overlap with some other invoice

Reports

• Can reports.html use a generic list view? What's the advantage in such a (more custom) view?

Forms

• Choose ModelForm (forms.py) or manual ones (in views.py) for reports. Not both.
  • And by that I mean: switch to ModelForms
• Instead of having multiple forms, you can play with JavaScript (I think AJAX or jQuery are the magic words here), to only show the "project" field after one or more "clients" have been selected. Then you can have just one form that shapeshifts based on what you entered
• The Password reset email doesn't work because Django can't send emails yet.
• Use django-datetimepicker for all forms' date fields

Misc/Fun

• Build some REST(ful?) API in the app, just to find out what exactly that is.
• Lint your project: python3 -m flake8 from the project root
• Build a FormMixin and consolidate e.g. ClientCreateView and ClientUpdateView
  • See ProductFormMixin in GSA/product/views.py
• Payment terms: 2% 10 Net 30, COD, and PIA don't yet work in the invoice app: You need to set a due date

Long-term / Features

• Store the last entered session as a foreign key in the User model. Then: When entering a session, suggest the first weekday after that session.
• A CV functionality. Track project descriptions, tools used, etc., and have it exportable as HTML, Word and PDF
• Omg the second image looks bomb: http://merehead.com/blog/build-online-crm-system/
• The "Reports" feature could have a Sankey Chart of Clients -> Projects -> Income. Can I put a Shiny app in a Django view?
• Suggestions from this post:
  • Don't use separate apps if foreign keys span across.