From a60a7b48d9bc644365ebd15dc727a47bf205154e Mon Sep 17 00:00:00 2001 From: "Baruch Odem (Rothkoff)" Date: Mon, 10 Feb 2020 18:10:52 +0200 Subject: [PATCH 1/3] Add prerequisites --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 94ff27d9..4f0374f1 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,12 @@ Please note that we are currently in **beta**, and issues under [Beta Milestone] ### Build Setup -#### Linux +#### Prerequisites + +- [NodeJS](https://nodejs.org/) version `^10.13.0` +- [Yarn](https://classic.yarnpkg.com) (`v1`-classic) + +##### Linux Currently, this project depends on `libsecret`, so you may need to install it before running `yarn`. @@ -65,7 +70,7 @@ Depending on your distribution, you will need to run the following command: Then you can run the commands below: -#### Windows / Linux +#### Commands ``` bash # install dependencies yarn From dd8b189f830a094fbfe593c7c1e4b9a240a99eb2 Mon Sep 17 00:00:00 2001 From: "Baruch Odem (Rothkoff)" Date: Tue, 11 Feb 2020 07:43:38 +0200 Subject: [PATCH 2/3] WIP --- README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 72 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4f0374f1..1bfc1d8f 100644 --- a/README.md +++ b/README.md @@ -51,14 +51,12 @@ Please note that we are currently in **beta**, and issues under [Beta Milestone] - [Brainstorming](https://github.com/baruchiro/israeli-bank-scrapers-desktop/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Abrainstorming+)- Design issues that I need help with and consultation from experienced people. - [Help wanted](https://github.com/baruchiro/israeli-bank-scrapers-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)- Issues I don't think I can do at this time. -### Build Setup - -#### Prerequisites +### Prerequisites - [NodeJS](https://nodejs.org/) version `^10.13.0` - [Yarn](https://classic.yarnpkg.com) (`v1`-classic) -##### Linux +#### Linux Currently, this project depends on `libsecret`, so you may need to install it before running `yarn`. @@ -70,7 +68,8 @@ Depending on your distribution, you will need to run the following command: Then you can run the commands below: -#### Commands +### Build Setup + ``` bash # install dependencies yarn @@ -88,3 +87,71 @@ yarn test yarn lint ``` + +### Project Structure + +``` ++---.github/workflows // Github Actions files ++---build/icons // Icons for Electron-Builder (used in vue.config.js) ++---dist/electron // Webpack temporary output +| ++---dist_electron // Installer and info files +| +---bundled // Bundle +| \---win-unpacked // Unpacked- what you will get after you run the installer +| ++---docs // Resources for documentation porpuse ++---public ++---scripts // Scripts for Git hooks and other needs +| ++---src +| +---assets +| +---components +| | \---MainPage +| | +---Exporters +| | \---Importers +| +---modules +| | +---encryption +| | \---spreadsheet +| +---plugins +| +---router +| +---service +| \---store +| +---migrations +| \---modules +\---test + +---e2e + | \---specs + \---unit + +---coverage + | \---lcov-report + | \---renderer + | +---components + | | \---MainPage + | | +---Exporters + | | \---Importers + | +---modules + | | +---encryption + | | \---spreadsheet + | +---store + | | +---migrations + | | \---modules + | \---vue-plugins + +---helpers + +---integrationSpecs + +---mock + \---specs +| +| .eslintrc.js +| .gitignore +| babel.config.js +| bash.txt +| jest.config.js +| jsconfig.json +| LICENSE +| package.json +| README.md +| tree.txt +| vue.config.js +| yarn-error.log +| yarn.lock +``` From 08ef67e7a866488fed2461e11de17e73f7650e51 Mon Sep 17 00:00:00 2001 From: "Baruch Odem (Rothkoff)" Date: Tue, 11 Feb 2020 18:46:03 +0200 Subject: [PATCH 3/3] Finish project structure --- README.md | 68 +++++++++++++------------------------------------------ 1 file changed, 16 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 1bfc1d8f..5eea49c8 100644 --- a/README.md +++ b/README.md @@ -91,67 +91,31 @@ yarn lint ### Project Structure ``` -+---.github/workflows // Github Actions files -+---build/icons // Icons for Electron-Builder (used in vue.config.js) -+---dist/electron // Webpack temporary output ++---.github/workflows // Github Actions files ++---build/icons // Icons for Electron-Builder (used in vue.config.js) ++---dist/electron // Webpack temporary output | -+---dist_electron // Installer and info files -| +---bundled // Bundle -| \---win-unpacked // Unpacked- what you will get after you run the installer ++---dist_electron // Installer and info files +| +---bundled // Bundle +| +---win-unpacked // Unpacked- what you will get after you run the installer | -+---docs // Resources for documentation porpuse ++---docs // Resources for documentation porpuse +---public -+---scripts // Scripts for Git hooks and other needs ++---scripts // Scripts for Git hooks and other needs | +---src | +---assets | +---components -| | \---MainPage -| | +---Exporters -| | \---Importers | +---modules -| | +---encryption -| | \---spreadsheet -| +---plugins -| +---router -| +---service -| \---store +| +---plugins // Vue plugins +| +---router // Vue-Router (for future use) +| \---store // Vuex | +---migrations -| \---modules +| +---modules +| \---test - +---e2e - | \---specs - \---unit - +---coverage - | \---lcov-report - | \---renderer - | +---components - | | \---MainPage - | | +---Exporters - | | \---Importers - | +---modules - | | +---encryption - | | \---spreadsheet - | +---store - | | +---migrations - | | \---modules - | \---vue-plugins - +---helpers - +---integrationSpecs - +---mock - \---specs +| +---e2e +| +---unit | -| .eslintrc.js -| .gitignore -| babel.config.js -| bash.txt -| jest.config.js -| jsconfig.json -| LICENSE -| package.json -| README.md -| tree.txt -| vue.config.js -| yarn-error.log -| yarn.lock +| vue.config.js // vue-cli-plugin-electron-builder (includes electron-builder config) ```