Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbc/digital-paper-edit-electron
Work in progress - BBC News Labs digital paper edit project - Electron, Cross Platform Desktop app - Mac, Windows, Linux
https://github.com/bbc/digital-paper-edit-electron
digital-paper-edit news-labs newslabs
Last synced: 10 days ago
JSON representation
Work in progress - BBC News Labs digital paper edit project - Electron, Cross Platform Desktop app - Mac, Windows, Linux
- Host: GitHub
- URL: https://github.com/bbc/digital-paper-edit-electron
- Owner: bbc
- License: other
- Created: 2019-05-20T10:53:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:45:52.000Z (over 1 year ago)
- Last Synced: 2024-04-08T21:02:36.085Z (7 months ago)
- Topics: digital-paper-edit, news-labs, newslabs
- Language: C++
- Size: 40.1 MB
- Stars: 24
- Watchers: 25
- Forks: 22
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Digital Paper Edit - Electron
Electron Cross Platform Desktop app
---> _Work in progress_ <--
For a ready to use release of the desktop application, checkout the [user instructions](./docs/guides/user-instructions.md) for more details on how to get started.
[See here for overall project architecture info](https://github.com/bbc/digital-paper-edit-client#project-architecture)
## Setup
```
git clone [email protected]:bbc/digital-paper-edit-electron.git
```
```
cd digital-paper-edit-electron
```
Optional step to setup [nvm](https://github.com/nvm-sh/nvm) to use node version 10, otherwise just use node version 10
```
nvm use || nvm install`
```
in root of project
```
npm install
```
## Usage
```
npm start
```
## System Architecture
Electron Cross platform desktop app
## Development env
- [ ] npm > `6.1.0`
- [ ] node v 10 - [lts/dubnium](https://scotch.io/tutorials/whats-new-in-node-10-dubnium)
- [ ] see [`.eslintrc`](./.eslintrc) in the various packages for linting rules
Node version is set in node version manager [`.nvmrc`](https://github.com/creationix/nvm#nvmrc)
## Build
_TBC_
## Tests
_TBC_
## Deployment
We use [Travis CI](https://travis-ci.org/bbc/digital-paper-edit-electron/builds/) to build. The Github access token (from newslabs_deploy user, which is the general News Labs deployment account) is used to deploy. This means that you **cannot** deploy directly by triggering a build via pushing to master. Because your access token isn't used. You would manually need to trigger the build through the Github UI (which is dumb), because then the changes you make from there is seen as the correct newslabs_deploy user by Travis CI.
There is a ticket to address this workaround: [issue](https://github.com/bbc/digital-paper-edit-electron/issues/6)