{"id":18377271,"url":"https://github.com/bbc/digital-paper-edit-electron","last_synced_at":"2025-04-06T21:31:35.676Z","repository":{"id":35805922,"uuid":"187622697","full_name":"bbc/digital-paper-edit-electron","owner":"bbc","description":" Work in progress - BBC News Labs digital paper edit project - Electron, Cross Platform Desktop app - Mac, Windows, Linux","archived":false,"fork":false,"pushed_at":"2023-07-18T20:45:52.000Z","size":42001,"stargazers_count":24,"open_issues_count":47,"forks_count":22,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-04-08T21:02:36.085Z","etag":null,"topics":["digital-paper-edit","news-labs","newslabs"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-20T10:53:14.000Z","updated_at":"2024-01-23T09:01:36.000Z","dependencies_parsed_at":"2023-02-18T02:45:19.962Z","dependency_job_id":null,"html_url":"https://github.com/bbc/digital-paper-edit-electron","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fdigital-paper-edit-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fdigital-paper-edit-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fdigital-paper-edit-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fdigital-paper-edit-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbc","download_url":"https://codeload.github.com/bbc/digital-paper-edit-electron/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223264071,"owners_count":17116043,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["digital-paper-edit","news-labs","newslabs"],"created_at":"2024-11-06T00:27:33.002Z","updated_at":"2024-11-06T00:27:33.741Z","avatar_url":"https://github.com/bbc.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n#  Digital Paper Edit - Electron \nElectron Cross Platform Desktop app\n\n---\u003e _Work in progress_ \u003c--\n\nFor 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.\n\n \n[See here for overall project architecture info](https://github.com/bbc/digital-paper-edit-client#project-architecture)\n\n## Setup\n\u003c!-- _stack - optional_\n_How to build and run the code/app_ --\u003e\n\n```\ngit clone git@github.com:bbc/digital-paper-edit-electron.git\n```\n\n```\ncd digital-paper-edit-electron\n```\n\nOptional step to setup [nvm](https://github.com/nvm-sh/nvm) to use node version 10, otherwise just use node version 10\n```\nnvm use || nvm install`\n```\n\nin root of project\n```\nnpm install\n```\n\n## Usage\n\n```\nnpm start\n```\n \n\n## System Architecture\n\u003c!-- _High level overview of system architecture_ --\u003e\n\n Electron Cross platform desktop app\n\n## Development env\n \u003c!-- _How to run the development environment_\n\n_Coding style convention ref optional, eg which linter to use_\n\n_Linting, github pre-push hook - optional_ --\u003e\n\n- [ ] npm \u003e `6.1.0`\n- [ ] node v 10 - [lts/dubnium](https://scotch.io/tutorials/whats-new-in-node-10-dubnium)\n- [ ] see [`.eslintrc`](./.eslintrc) in the various packages for linting rules\n\nNode version is set in node version manager [`.nvmrc`](https://github.com/creationix/nvm#nvmrc)\n\n## Build\n\u003c!-- _How to run build_ --\u003e\n\n\u003c!-- \nTODO: needs to pull in React front end from npm. \neg how it was done in Makefile before\n\nbuild-electron: build-react\n\t@echo \"Electron build\"\n\t# does areact-build\n\t# clears build folder inside of electron\n\trm -rf ./packages/electron/build\n\trm -rf ./packages/electron/dist\n\t# then copies the react build folder into electron folder\n\tcp -a ./packages/client/build ./packages/electron/build\n\t# build/package electron for mac, wind and linux\n\tcd ./packages/electron \u0026\u0026 npm run build:mwl\n\nand then run \n\n```\nnpm run build:mwl\n```\n --\u003e\n\n_TBC_\n\n## Tests\n\n _TBC_\n\n## Deployment\n\u003c!-- _How to deploy the code/app into test/staging/production_ --\u003e\n\nWe 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.\n\nThere is a ticket to address this workaround: [issue](https://github.com/bbc/digital-paper-edit-electron/issues/6)\n\u003c!-- Probably through Travis or Circle CI --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbc%2Fdigital-paper-edit-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbc%2Fdigital-paper-edit-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbc%2Fdigital-paper-edit-electron/lists"}