{"id":18936320,"url":"https://github.com/shellbear/faktur","last_synced_at":"2025-04-15T18:31:28.192Z","repository":{"id":57603991,"uuid":"253011443","full_name":"shellbear/faktur","owner":"shellbear","description":"Invoice generator as a service","archived":false,"fork":false,"pushed_at":"2023-06-04T11:51:55.000Z","size":451,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T00:41:13.550Z","etag":null,"topics":["api","facture","faktur","go","golang","invoice","microservice","rest","wkhtmltopdf"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shellbear.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-04T14:00:42.000Z","updated_at":"2023-09-06T12:26:58.000Z","dependencies_parsed_at":"2024-06-20T02:54:46.490Z","dependency_job_id":"821892d5-49c9-41a1-b670-cb953b504492","html_url":"https://github.com/shellbear/faktur","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellbear%2Ffaktur","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellbear%2Ffaktur/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellbear%2Ffaktur/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellbear%2Ffaktur/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shellbear","download_url":"https://codeload.github.com/shellbear/faktur/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249129098,"owners_count":21217283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","facture","faktur","go","golang","invoice","microservice","rest","wkhtmltopdf"],"created_at":"2024-11-08T12:06:59.125Z","updated_at":"2025-04-15T18:31:27.418Z","avatar_url":"https://github.com/shellbear.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\r\n  \u003cimg alt=\"Gopher\" src=\".github/images/gopher.png\" height=\"140\" /\u003e\r\n  \u003ch3 align=\"center\"\u003eFaktur\u003c/h3\u003e\r\n  \u003cp align=\"center\"\u003eInvoice generator as a service.\u003c/p\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://goreportcard.com/report/github.com/shellbear/faktur\" alt=\"Go Report Card\"\u003e\r\n    \u003cimg src=\"https://goreportcard.com/badge/github.com/shellbear/faktur\" /\u003e\r\n  \u003c/a\u003e\r\n  \u003ca href=\"https://github.com/shellbear/faktur/actions?query=workflow%3Alint\" alt=\"Pipeline status\"\u003e\r\n    \u003cimg src=\"https://github.com/shellbear/faktur/workflows/lint/badge.svg\" /\u003e\r\n  \u003c/a\u003e\r\n  \u003cimg src=\"https://img.shields.io/github/go-mod/go-version/shellbear/faktur\" alt=\"Go version\" /\u003e\r\n  \u003ca href=\"https://opensource.org/licenses/MIT\" alt=\"Go version\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-brightgreen.svg\" /\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n---\r\n\r\n## Installation\r\n\r\nWith go CLI:\r\n```shell script\r\ngo build -o faktur .\r\n./faktur\r\n```\r\n\r\nWith docker:\r\n```shell script\r\ndocker run        \\\r\n  --name faktur   \\\r\n  -p 8080:8080    \\\r\n  -d              \\\r\n  docker.pkg.github.com/shellbear/faktur/faktur\r\n```\r\n\r\nOr download binary from the release [page](https://github.com/shellbear/faktur/releases).\r\n\r\n## How it works?\r\n\r\n![faktur](.github/images/faktur.png)\r\n\r\n## Api\r\n\r\n```\r\n$ curl --header \"Content-Type: application/json\" \\\r\n    --request POST \\\r\n    --data-binary @data_example.json \\\r\n    http://localhost:8080/\r\n```\r\n```json\r\n{\r\n    \"title\": \"StoneCrete Flooring - Invoice\",\r\n    \"date\": \"2023-05-15T12:30:05.371Z\",\r\n    \"due_date\": \"2023-05-27T12:30:05.371Z\",\r\n    \"currency\": \"$\",\r\n    \"contractor\": {\r\n      \"logo\": \"https://type_your_link_here.com\",\r\n      \"business_name\": \"StoneCrete Inc,\",\r\n      \"phone\": \"(407)640-2333\",\r\n      \"email\": \"office@stonecreteflooring.com\",\r\n      \"registration_number\": \"N/A\",\r\n      \"address\": {\r\n        \"address\": \"7901 4Th St N Ste 300\", \r\n\t    \"city\": \"St. Petersburg\",\r\n        \"state\": \"FL\",\r\n        \"zip_code\": \"33702\"\r\n      }\r\n    },\r\n    \"customer\": {\r\n      \"full_name\": \"Acme Inc,\",\r\n      \"phone\": \"(689)250-4444\",\r\n      \"email\": \"example@example.com\",\r\n      \"terms\": \"NET60\",\r\n      \"address\": {\r\n        \"address\": \"212 Ronnie St\", \r\n\t    \"city\": \"Somewhere\",\r\n        \"state\": \"FL\",\r\n        \"zip_code\": \"33233\"\r\n      },\r\n      \"amount_paid\": \"50.00\",\r\n      \"customer_notes\": \"Payments accepted: wire transfer, check, or credit card.\"\r\n    },\r\n    \"items\": [\r\n\r\n      {\r\n        \"item_number\": \"2005\",\r\n        \"description\": \"Additional clear urethane top coat\",\r\n        \"rate\": 200.41,\r\n        \"quantity\": 1.0,\r\n        \"tax_rate\": 0.07\r\n      },\r\n      {\r\n        \"item_number\": \"4002\",\r\n        \"description\": \"Epoxy Metallic blue and clear urethane coat\",\r\n        \"rate\": 1400.25,\r\n        \"quantity\": 2.0,\r\n        \"tax_rate\": 0.07\r\n      }\r\n    ]\r\n}\r\n```\r\n\r\n## Environment variables\r\n\r\n##### `FAKTUR_HOST`\r\n\r\nFaktur service host address. Defaults to `127.0.0.1`.\r\n\r\n##### `FAKTUR_PORT`\r\n\r\nFaktur service port. Defaults to `8080`.\r\n\r\n##### `FAKTUR_WORKERS`\r\n\r\nThe number of workers (used to create invoices). Defaults to `4`.\r\n\r\n##### `FAKTUR_INVOICE_DIR`\r\n\r\nThe folder used to store invoices. Defaults to `./invoices`.\r\n\r\n##### `FAKTUR_TEMPLATE_DIR`\r\n\r\nAn optional directory which contains additional invoice templates. Empty by default.\r\n\r\n##### `FAKTUR_CACHE_DIR`\r\n\r\nThe cache folder for wkhtmltopdf. Defaults to `/tmp/cache-wk/`.\r\n\r\n## Built with\r\n\r\n- [pkger](https://github.com/markbates/pkger)\r\n- [go-wkhtmltopdf](https://github.com/SebastiaanKlippert/go-wkhtmltopdf)\r\n- \u003cdel\u003e[basscss](https://github.com/basscss/basscss)\u003c/del\u003e\r\n- [getbase](https://getbase.org/)\r\n\r\n## Credits\r\n\r\n- Artwork by [Ashley McNamara](https://twitter.com/ashleymcnamara)\r\n- Inspired by [Renee French](http://reneefrench.blogspot.co.uk/)\r\n\r\n## License\r\n\r\n© shellbear, 2020~time.Now\r\n© StoneCrete, 2023~time.Now\r\n\r\nReleased under the [MIT License](LICENSE).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellbear%2Ffaktur","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshellbear%2Ffaktur","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellbear%2Ffaktur/lists"}