Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nevinmathew/invoice-system-application
A spring application that generates the invoice for the products purchased.
https://github.com/nevinmathew/invoice-system-application
cockroachdb docker graphql java lombok openpdf redis spring-boot
Last synced: 8 days ago
JSON representation
A spring application that generates the invoice for the products purchased.
- Host: GitHub
- URL: https://github.com/nevinmathew/invoice-system-application
- Owner: nevinmathew
- License: mpl-2.0
- Created: 2023-02-20T14:08:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T08:57:12.000Z (9 months ago)
- Last Synced: 2024-11-07T10:20:33.384Z (about 2 months ago)
- Topics: cockroachdb, docker, graphql, java, lombok, openpdf, redis, spring-boot
- Language: Java
- Homepage:
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# Invoice System
The Invoice System is a Java-based Spring Boot application designed to manage and generate invoices for products bought by users. It utilizes CockroachDB for database management, Redis for caching, and integrates GraphQL for querying data.
## Table of Contents
1. [Languages and Tools](#languages-and-tools)
2. [Dependencies](#dependencies)
- [CockroachDB](#cockroachdb)
- [Redis](#redis)
- [GraphQL](#graphql)
- [Docker Setup](#docker-setup)
- [Lombok](#lombok)
- [PDF Generation Library (OpenPDF)](#pdf-generation-library-openpdf)
- [Key Features](#key-features)
- [Integration in Invoice System](#integration-in-invoice-system)
3. [Configuration](#configuration)
- [application.properties](#applicationproperties)
4. [License](#license)
Languages and Tools:
## Dependencies
- Spring Boot
- CockroachDB
- Redis
- GraphQL
- Lombok
- OpenPDF
### CockroachDB:
[Click here](https://www.cockroachlabs.com/docs/stable/install-cockroachdb-windows) to install CockroachDB.
Open powershell and run the following command -
```powershell
C:\Users\Admin\Downloads> cockroach start-single-node --insecure `
>> --listen-addr=localhost:26257 `
>> --http-addr=localhost:8080
```
### Redis:
Install WSL, enable the necessary features, and restart the system.
Install Ubuntu distros for windows.
Launch Ubuntu and install the Redis server
Run the following command to run redis server:
```bash
redis-server
```
Run redis-cli and run the command ‘ping’. If you get the response ’pong’ then redis is running.
[Click here](https://download.redisinsight.redis.com/latest/RedisInsight-v2-win-installer.exe/) to install RedisInsight in your windows system to view the data in Redis.
### GraphQL:
Url: http://localhost:8080/api/graphql
The GraphQL queries for the APIs in the application:
```graphql
{
getAllInvoices
{
products{
id
name
price
quantity
totalPrice
transactionId
}
paymentStatus
amount
}
}
```
```graphql
{
getInvoice(id: "3f31fda3-9e28-4798-8766-2b6e40634dcb")
{
products{
id
name
price
quantity
totalPrice
transactionId
}
paymentStatus
amount
}
}
```
```graphql
mutation{
saveInvoice(prods: [{name:" ",price: 14.0,quantity:4,totalPrice: null,transactionId: id"}],payment: true)
{
id
products{
id
name
price
quantity
totalPrice
transactionId
}
createdDate
createdTime
paymentStatus
amount
}
}
```
```graphql
mutation{
updateInvoice(prods: [{id:"id",name:" ",price: 14.0,quantity:4,totalPrice: 56.0,transactionId: "id"}],id: "id",payment: true)
{
id
products{
id
name
price
quantity
totalPrice
transactionId
}
createdDate
createdTime
paymentStatus
amount
}
}
```
```graphql
mutation{
deleteInvoice(id: "d4ce58dc-bd3d-4205-b929-43b1835498e4")
}
```
### Docker Setup:
The project includes Dockerfiles and a docker-compose.yml file for easy deployment using Docker. Follow the steps in the Docker Setup section above.
To download the images from the docker repository:
```bash
docker pull nevin1m/invoice-system -a
```
### Lombok
[Lombok](https://projectlombok.org/) is a Java library that helps to reduce boilerplate code in your Spring Boot application. It provides a set of annotations that automatically generate common code during compilation, making your code more concise and readable. Start using Lombok annotations in your code to reduce verbosity and improve code readability.
#### Key Features
1. **@Getter and @Setter**: Automatically generate getter and setter methods for your classes.
2. **@NoArgsConstructor, @AllArgsConstructor, and @RequiredArgsConstructor**: Generate constructors without the need for boilerplate code.
3. **@EqualsAndHashCode**: Automatically generate equals and hashCode methods based on the fields of your class.
4. **@ToString**: Automatically generate a meaningful toString method.
To integrate Lombok into your project, add the Lombok dependency to your build configuration.
### OpenPDF
The Invoice System leverages [OpenPDF](https://github.com/LibrePDF/OpenPDF), an open-source PDF generation library for Java, to dynamically create and manage PDF documents. OpenPDF simplifies the process of generating professional-looking invoices.
#### Key Features:
- **Text Formatting:** Precise control over text formatting ensures polished and professional PDF content.
- **Image Embedding:** Supports embedding images into PDFs, facilitating the inclusion of logos and graphical elements.
- **Page Manipulation:** Functionality for manipulating pages enhances organization and structure within generated documents.
#### Integration in Invoice System:
OpenPDF seamlessly integrates with the Spring Boot application, enhancing user experience by delivering well-designed and visually appealing invoices.
## Configuration
application.properties: Configure database connections, GraphQL, and other application properties.
## License
This project is licensed under the MPL License - see the [LICENSE.md](https://github.com/nevinmathew/Invoice-system-application/blob/main/License) file for details.