Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PDF editing #9

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
675 changes: 675 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,39 @@
# DocsTogether
# DocDocGoose

A web app for editing your documents (PDF, Microsoft Word DOCX, etc). DocsTogether processes your documents on your computer without your documents ever being uploaded. No need to install any PDF editing software, and your files never leave your computer.
A web app for editing your documents (`.pdf`, `.docx`, etc). DocDocGoose processes your documents on your computer without your documents ever being uploaded. No need to install any PDF editing software, and your files never leave your computer.

## Development

Ensure you have Node.JS installed.
### Setup

Ensure you have Node.JS installed, then install the `npm` dependencies.

```shell
npm i

```

### WebAssembly

DocsTogether uses [pdfcpu](https://github.com/pdfcpu/pdfcpu), a PDF processing library written in Golang. To build an updated WASM module for [pdfcpu](https://github.com/pdfcpu/pdfcpu), ensure Golang is installed, then run `./scripts/build-pdfcpu-wasm.sh`.
DocDocGoose uses [pdfcpu](https://github.com/pdfcpu/pdfcpu), a PDF processing library written in Golang. To build an updated WASM module for [pdfcpu](https://github.com/pdfcpu/pdfcpu), ensure Golang is installed, then run `./scripts/build-pdfcpu-wasm.sh`.

To run the WASM module in NodeJS, `cd` into the `public/wasm` folder and run `node node_wasm.js`.

Current `pdfcpu` commit: [b9818b8a01eaaa742ef42cb9982fa4661445453e](https://github.com/pdfcpu/pdfcpu/commit/b9818b8a01eaaa742ef42cb9982fa4661445453e)

### Running in development

```shell
npm run dev
```

## Production

```shell
npm run build
netlify deploy --prod
```

## Browser Support

DocsTogether aims to support recent versions of Google Chrome, Mozilla Firefox, and Microsoft Edge. Other browsers may be supported as well if the requirements are not conflicting or drastically different. Microsoft Internet Explorer is not supported.
DocDocGoose aims to support recent versions of Google Chrome, Mozilla Firefox, and Microsoft Edge. Other browsers may be supported as well if the requirements are not conflicting or drastically different. Microsoft Internet Explorer is not supported.
169 changes: 162 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "space-together",
"name": "DocDocGoose",
"version": "0.0.1",
"description": "in-browser editing of documents",
"main": "index.js",
Expand All @@ -11,14 +11,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/hueyy/docs-together.git"
"url": "git+https://github.com/hueyy/docdocgoose"
},
"author": "Huey Lee <[email protected]>",
"license": "UNLICENSED",
"license": "AGPL-3.0-or-later",
"bugs": {
"url": "https://github.com/hueyy/docs-together/issues"
"url": "https://github.com/hueyy/docdocgoose/issues"
},
"homepage": "https://github.com/hueyy/docs-together#readme",
"homepage": "https://github.com/hueyy/docdocgoose#readme",
"devDependencies": {
"@types/node": "^18.0.1",
"@types/react": "^18.0.14",
Expand All @@ -39,10 +39,12 @@
"fast-xml-parser": "^4.0.8",
"jszip": "^3.10.0",
"next": "^12.2.0",
"pdf-lib": "^1.17.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-dropzone": "^14.2.2",
"react-pdf": "^5.7.2",
"react-rnd": "^10.3.7",
"unzipper": "^0.10.11"
}
}
4 changes: 2 additions & 2 deletions public/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "DocsTogether",
"short_name": "DocsTogether",
"name": "DocDocGoose",
"short_name": "DocDocGoose",
"start_url": "/",
"display": "standalone",
"background_color": "#1e293b1a",
Expand Down
Loading