forked from acaldas/document-model-electron
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "feat: merge branch 'arb-ltip' into deployments/arbitrum"
- Loading branch information
Showing
82 changed files
with
8,167 additions
and
8,142 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,7 +36,10 @@ | |
} | ||
], | ||
[ | ||
"@semantic-release/github" | ||
"@semantic-release/github", | ||
{ | ||
"draftRelease": true | ||
} | ||
] | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,64 @@ | ||
# Powerhouse Connect | ||
# Document Model Editor Demo | ||
|
||
Open-source desktop and web application for document model management. | ||
Interact, create, edit and manage documents with ease. | ||
Demo Electron app to interact with Budget Statement documents. | ||
|
||
- Connect functions as a private editor & contributor tool for contributors of open organisations. It allows teams to manage internal documents with full control over the data ownership. Connect is available as stand-alone desktop application or in the cloud. | ||
- Connect offers a navigation menu for adding, synchronising and browsing document drives that are shared within an organisation or are private to the contributor. | ||
- Connect allows contributors to edit and work on different 'document model types' selected or defined by the organisation. | ||
## Quickstart | ||
|
||
![app](./.github/app.png) | ||
``` | ||
npm install | ||
npm run dev:web | ||
``` | ||
|
||
## Usage | ||
|
||
Install dependencies: | ||
|
||
```bash | ||
$ yarn install | ||
``` | ||
|
||
Start development mode: | ||
|
||
```bash | ||
$ yarn start | ||
``` | ||
|
||
## Prerequisites | ||
Run browser version only: | ||
|
||
You can follow these instructions to setup a dev environment: | ||
```bash | ||
$ yarn start:web | ||
``` | ||
|
||
- Install [**Node (LTS)**](https://nodejs.org/en/download/) | ||
- Clone this repository | ||
- Run `npm install` to install dependencies | ||
Create package for the current platform: | ||
|
||
```bash | ||
$ yarn make | ||
``` | ||
|
||
**Starting Connect** | ||
Build for Mac OSX: (only works on Mac) | ||
|
||
```bash | ||
npm start # start desktop app | ||
# OR | ||
npm run dev:web # start web app | ||
$ npm make:mac | ||
``` | ||
|
||
After initialized, you can access the web app at `http://localhost:5173`. | ||
Build for Linux (deb and dpkg): (works on Linux or Mac) | ||
|
||
**Create a packaged version of the desktop app** | ||
```bash | ||
$ npm make:linux | ||
``` | ||
|
||
Build for Windows: (only works on Windows) | ||
|
||
```bash | ||
npm run make # Create package for the current platform | ||
npm run make:mac # Create package for Mac OSX | ||
npm run make:linux # Create package for Linux | ||
npm run make:windows # Create package for Windows | ||
$ npm make:windows | ||
``` | ||
|
||
## Troubleshooting | ||
|
||
- For a complete list of *Electron Forge* options and requirements, visit the [official docs](https://github.com/electron-userland/electron-forge#usage). | ||
|
||
- If you're experiencing troubles with node-gyp on Windows 11, follow [this guide](https://devkimchi.com/2021/11/26/troubleshooting-node-gyp-package-on-windows11/). | ||
|
||
- If you're experiencing troubles with node-gyp on older versions, check out [this guide](https://spin.atomicobject.com/2019/03/27/node-gyp-windows/). | ||
- If you're experiencing troubles with node-gyp on Windows 11, follow [this guide](https://devkimchi.com/2021/11/26/troubleshooting-node-gyp-package-on-windows11/). | ||
|
||
- To use yarn via Windows PowerShell, check [this guide](https://bobbyhadz.com/blog/yarn-cannot-be-loaded-running-scripts-disabled) | ||
- If you're experiencing troubles with node-gyp on older versions, check out [this guide](https://spin.atomicobject.com/2019/03/27/node-gyp-windows/). | ||
|
||
- For any other issues, reach out to our discord server [`#ask-powerhouse-team`](https://discord.com/channels/815917281728659516/883285185595047937) channel for help. | ||
- To use yarn via Windows PowerShell, check [this guide](https://bobbyhadz.com/blog/yarn-cannot-be-loaded-running-scripts-disabled) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.