Skip to content

Commit 84f95fa

Browse files
committed
README: Updated documentation
Signed-off-by: Dicky Herlambang (花) <[email protected]>
1 parent 4020f20 commit 84f95fa

File tree

3 files changed

+23
-12
lines changed

3 files changed

+23
-12
lines changed

Diff for: README.md

+23-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
## HANA PDF
2-
HANA PDF is a __Laravel__ based project powered by front-end framework like __ViteJS__ and __Tailwind CSS__ and used of __Flowbite__ library to maintain responsive and materialize interface. And with integration from __iLovePDF__ and __Aspose Cloud__ API as one of the back-end, it have feature to merge, split, compress, convert, and add watermarks to PDF documents, that can handle easily and quickly.
2+
3+
<br>
4+
<div style="text-align: center;">
5+
<img src="screenshot/logo.png" alt="HANA" width="300" height="300">
6+
</div>
7+
<br>
8+
9+
__HANA PDF__ is your go-to solution for effortlessly managing your PDFs. We've designed it with simplicity in mind, so you can edit,
10+
combine, shrink, convert, and personalize your PDFs with just a few clicks. And was implemented with front-end framework like ViteJS and Tailwind CSS and used of Flowbite library to maintain responsive and materialize interface. And powered with iLovePDF and Aspose Cloud API as one of the back-end.
311

412
---
513

@@ -14,11 +22,9 @@ HANA PDF is a __Laravel__ based project powered by front-end framework like __Vi
1422
* On Windows use Docker Desktop
1523
* On Linux use docker-compose and docker.io
1624
- [Node JS 20.11](https://nodejs.org/en)
17-
- [Flowbite](https://flowbite.com/)
1825
- [PHP 8.2.12](https://www.php.net/downloads.php)
1926
- [PostgreSQL 16.2](https://www.postgresql.org/)
2027
- [Python 3.10.x](https://www.python.org/downloads/release/python-31011/)
21-
- [Tailwind CSS](https://tailwindcss.com/)
2228
- [Vite JS](https://vitejs.dev/)
2329

2430
---
@@ -84,10 +90,11 @@ HANA PDF is a __Laravel__ based project powered by front-end framework like __Vi
8490
- ILOVEPDF_ENC_KEY="ILOVEPDF_ENC_KEY" [Generate your hash key (Max. 25 digits)]
8591
- ILOVEPDF_PUBLIC_KEY="ILOVEPDF_PUBLIC_KEY" [https://developer.ilovepdf.com/]
8692
- ILOVEPDF_SECRET_KEY="ILOVEPDF_SECRET_KEY" [https://developer.ilovepdf.com/]
87-
- ILOVEPDF_EXT_IMG_DIR="temp-image"
88-
- PDF_MERGE_TEMP="temp-merge"
89-
- PDF_UPLOAD="upload-pdf"
90-
- PDF_DOWNLOAD="temp"
93+
- PDF_IMG_POOL="image"
94+
- PDF_BATCH="batch"
95+
- PDF_UPLOAD="upload"
96+
- PDF_DOWNLOAD="download"
97+
- PDF_POOL="pool"
9198
- TELEGRAM_BOT_ID="YOUR_TELEGRAM_BOT_ID" [https://telegram-bot-sdk.com/docs/getting-started/installation]
9299
- TELEGRAM_CHAT_ID="YOUR_TELEGRAM_CHANNEL_ID" [https://telegram-bot-sdk.com/docs/getting-started/installation]
93100
- TOKEN_GENERATE="YOUR_ENCODE_SHA512_TOKEN"
@@ -100,10 +107,11 @@ HANA PDF is a __Laravel__ based project powered by front-end framework like __Vi
100107
- php artisan migrate
101108
```
102109
5. Create new directory inside storage/app/public
103-
- temp
104-
- temp-image
105-
- temp-merge
106-
- upload-pdf
110+
- image
111+
- batch
112+
- upload
113+
- download
114+
- pool
107115
6. Start to deploy
108116
```bash
109117
- npm run dev -- --host
@@ -115,17 +123,20 @@ HANA PDF is a __Laravel__ based project powered by front-end framework like __Vi
115123
### Technology Stack
116124
- [Aspose](https://www.aspose.cloud/)
117125
- [Docker](https://www.docker.com/)
126+
- [DropzoneJS](https://www.dropzone.dev/)
118127
- [Flowbite](https://flowbite.com/)
119128
- [iLovePDF](https://developer.ilovepdf.com/)
120129
- [Node JS](https://nodejs.org/en)
130+
- [PDFJS](https://mozilla.github.io/pdf.js/)
131+
- [PHPOffice](https://github.com/PHPOffice)
121132
- [Python](https://www.python.org/)
122133
- [Tailwind CSS](https://tailwindcss.com/)
123134
- [Vite JS](https://vitejs.dev/)
124135

125136
---
126137

127138
### License
128-
The HANA-CI PDF is a open source Laravel Project that has licensed under the [MIT license](https://opensource.org/licenses/MIT).
139+
The HANA PDF is a open source Laravel Project that has licensed under the [MIT license](https://opensource.org/licenses/MIT).
129140

130141
---
131142

Diff for: screenshot/1.png

219 KB
Loading

Diff for: screenshot/logo.png

39.6 KB
Loading

0 commit comments

Comments
 (0)