Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dipankardas011/pdf-editor
A web-based PDF Editor tool
https://github.com/dipankardas011/pdf-editor
argocd docker dockercompose express-js go golang hacktoberfest helm helm-charts html-css jest kubernetes nodejs npm pdf redis tekton-pipelines
Last synced: 3 months ago
JSON representation
A web-based PDF Editor tool
- Host: GitHub
- URL: https://github.com/dipankardas011/pdf-editor
- Owner: dipankardas011
- License: mit
- Archived: true
- Created: 2021-10-06T13:33:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-16T08:34:03.000Z (over 1 year ago)
- Last Synced: 2024-09-27T21:05:12.737Z (3 months ago)
- Topics: argocd, docker, dockercompose, express-js, go, golang, hacktoberfest, helm, helm-charts, html-css, jest, kubernetes, nodejs, npm, pdf, redis, tekton-pipelines
- Language: HTML
- Homepage: https://pdf-web-editor.azurewebsites.net/
- Size: 25.9 MB
- Stars: 38
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# Web-based PDF Editor π₯³
Website that can edit PDF's to give you a Merged or a Rotated version of it
[![Golang and Docker CI](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CI.yaml/badge.svg?branch=main)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CI.yaml) [![pages-build-deployment](https://github.com/dipankardas011/PDF-Editor/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/pages/pages-build-deployment) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/pdf-editor-web)](https://artifacthub.io/packages/search?repo=pdf-editor-web) [![CodeQL](https://github.com/dipankardas011/PDF-Editor/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/codeql-analysis.yml) [![\[Stable\](Backend-merger) Docker Signed Image Release](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CD-backend-merge.yaml/badge.svg)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CD-backend-merge.yaml) [![\[Stable\](Backend-rotate) Docker Signed Image Release](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CD-backend-rotate.yaml/badge.svg)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CD-backend-rotate.yaml) [![\[Stable\](Frontend) Stable Docker Signed Image Release](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CD-frontend.yaml/badge.svg)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/CD-frontend.yaml) [![Datree-policy-Checks](https://github.com/dipankardas011/PDF-Editor/actions/workflows/Datree-CD.yaml/badge.svg?branch=main)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/Datree-CD.yaml) [![ImageScan [Aqua Trivy]](https://github.com/dipankardas011/PDF-Editor/actions/workflows/imageScan.yaml/badge.svg)](https://github.com/dipankardas011/PDF-Editor/actions/workflows/imageScan.yaml) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/dipankardas011/PDF-Editor)[![CircleCI](https://dl.circleci.com/status-badge/img/gh/dipankardas011/PDF-Editor/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/dipankardas011/PDF-Editor/tree/main)
> **Note**
> it's no longer being maintained## Software Requirement Specification
[Link for entire Documentation about this project](https://docs.google.com/document/d/e/2PACX-1vQvfAZFG0Tw9MAXtXXXDDGFZ6967Iz9CK1rTE9Gl-cR8fKF268qoggKPIUhKGD3fWszGFEUfwoKYC9D/pub)
[Project Board For Current Status](https://github.com/users/dipankardas011/projects/2/views/1)
~Jenkins server -> [URL](http://ec2-XX-XX-XX-XX.compute-1.amazonaws.com:8080/)~
> **Note**> User: `guest`
> Pass: `77777`> (Available till 15th Sep '22) Due to π° had to stop the instance
Stage | Tags | Links | Status
--|--|--|--
Production | `1.0` | (Azure Web-Apps) https://pdf-web-editor.azurewebsites.net/, (Okteto) https://frontend-lb-dipankardas011.cloud.okteto.net/ | β
Alpha | `latest` ; `1.0` | ~http://44.209.39.161/~ | β> A Humble request! π don't expoit the resources I have used here
> Release Cycle of ~1 Month
### Tech Stack
* GO
* Docker & Docker-Compose
* HTML
* K8s
* Helm
* ArgoCD
* Terraform
* Flux
* Prometheus# Website
![](./coverpage.png)# How to Run
## Kustomize install
```bash
kubectl apply -k deploy/cluster/backend
kubectl apply -k deploy/cluster/frontend
```---
## Helm plugin
### Usage
```bash
kubectl create ns pdf
helm repo add pdf-editor-web https://dipankardas011.github.io/PDF-Editor/
helm install my-pdf-editor-helm pdf-editor-web/pdf-editor-helm --version 0.1.0
```
To uninstall the chart:helm delete my-pdf-editor-helm
---
## From Source Code
```bash
cd deploy/cluster/
kubectl create ns pdf
helm install ./pdf-editor-helm
helm uninstall ./pdf-editor-helm
```---
## ArgoRollouts
```
# using Argo-CD to deploy
deploy the path deploy/rollouts
With namespace set to pdf-editor-ns
```# How to Run
```bash
make run
```# How to Dev
```bash
cd src/
skaffold dev
```# How to Test
```bash
# Integration testing
make unit-test
# Integration testing
make integration-test
```# To View the page visit
```url
http://localhost
```# Production Cluster (demo)
Civo Dashboard
![image](https://user-images.githubusercontent.com/65275144/199149205-3c34da17-6b68-46ec-b2ce-737d09dc132c.png)
Youtube Video
[![IMAGE ALT TEXT](http://img.youtube.com/vi/bstJHtv0L_s/0.jpg)](http://www.youtube.com/watch?v=bstJHtv0L_s "Video Title")# Blog Post on this project
[![](./coverpage.png)](https://blog.kubesimplify.com/about-my-pdf-editor-project)# Decission Tree
# Trace
![](./trace.png)## Frontend -> Backend-Merger
```mermaid
flowchart LR;
XX[START]:::white--/merger-->web{Website};
web{Website}-->B{Upload PDF1};
web{Website}-->C{Upload PDF2};
DD{Download Link}-->web{Website};classDef green color:#022e1f,fill:#00f500;
classDef red color:#022e1f,fill:#f11111;
classDef white color:#022e1f,fill:#fff;
classDef black color:#fff,fill:#000;
classDef BLUE color:#fff,fill:#00f;B--Upload PDF-1-->S[GO Server]:::green;
C--Upload PDF-2-->S[GO Server]:::green;S[GO server]-->DD{Merged PDF available}
web--/merger/download-->dd{Download};
dd--->YY[END]:::BLUE;
```## Frontend -> Backend-Rotator
```mermaid
flowchart LR;
XX[START]:::white--/rotator-->web{Website};
web{Website}-->B{Upload PDF};
web{Website}-->C{Additional Parameters};
DD{Download Link}-->web{Website};classDef green color:#022e1f,fill:#00f500;
classDef red color:#022e1f,fill:#f11111;
classDef white color:#022e1f,fill:#fff;
classDef black color:#fff,fill:#000;
classDef BLUE color:#fff,fill:#00f;B--Upload PDF-->S[GO Server]:::green;
C--upload Params-->S[GO Server]:::green;S[GO server]-->DD{Rotated PDF available}
web--/rotator/download-->dd{Download};
dd--->YY[END]:::BLUE;```
[**Changelog link**](./CHANGELOG.md)
[**Code Of Conduct**](./code-of-conduct.md)
[**Contributing Guidelines**](./CONTRIBUTING.md)
Happy Coding ππΌπ₯³
Made with [contributors-img](https://contrib.rocks).