Skip to content

terrameijar/invoices

Repository files navigation

Invoice Generator

A Django Powered Invoice Generator

Django Invoice Generator

A free and simple invoicing solution.

terrameijar codecov

This invoice generator is a Django powered online tool to build PDF invoices from your web browser using a ready made template.

Screenshots

Screencast

Development setup

Django invoices runs in a docker container and uses a Postgres 9.x image. Before you can run it, you need to have Docker and Docker-compose installed

  • Install Docker and docker compose for your platform

  • clone the repo:

    git clone git@github.com:terrameijar/invoices.git
  • Build and run the project:

    docker compose build
    docker compose up
  • To run the automated tests:

    make test

Release History

  • 0.0.1
    • Work in progress

Meta

Vuyisile Ndlovu – @terrameijar vuyisile.com

Distributed under the GNU GENERAL PUBLIC LICENSE license. See LICENSE for more information.

https://github.com/terrameijar/

Contributing

  1. Fork it (https://github.com/terrameijar/divio-django-invoice)

  2. Create your feature branch (git checkout -b feature/fooBar)

  3. Run lint checks

    make lint

    If lint check fails, make the necessary changes and run the linter again until the lint check passes. If the code needs formatting, run black:

    make format

    When the lint check passes, run the automated tests.

  4. Run tests to ensure that your changes didn't break anything:

    make test
  5. Commit your changes (git commit -am 'Add some feature')

  6. Push to the branch (git push origin feature/fooBar)

  7. Create a new Pull Request in GitHub against the develop branch.

About

A Django based invoicing app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published