README
¶
SimpleInvoice
This project is a simple API built in Golang that allows users to create invoice PDFs. It provides a straightforward way to generate professional-looking invoices with customizable features. This project aims to be user-friendly and developer-friendly, with simple and easy-to-understand endpoints.
How to Run
To run the Invoice PDF Creator API, follow these steps:
- Install Go Version 1.18.x from the official webpage https://go.dev/
- Clone the repository to your local machine.
git clone https://github.com/TheFpiasta/SimpleInvoice.git - Run
go run main.goin the terminal from the root directory of the project. - The server should start running on http://localhost:10000.
Endpoints
Once the application is running, you can send a POST request a JSON body containing the necessary invoice details. The following pdf types are implemented:
| API endpoint | Description | JSON body |
|---|---|---|
| /invoice | to generate a invoice | template example |
| /delivery-node | to generate a delivery node | template example |
The API will return a PDF if no error occurred, or the error message in json format.
Customization
If you would like to contribute to SimpleInvoice, please fork the repository and submit a pull request. Contributions are always welcome, and we appreciate your help in making SimpleInvoice even better!
License
SimpleInvoice is released under the MIT license. See 'LICENSE' for more information.
Documentation
¶
There is no documentation for this package.
Source Files
Directories