diff --git a/README.md b/README.md index 02ba7196..d2ac6ac0 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,10 @@ 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 + +- [NodeJS](https://nodejs.org/) version `^10.13.0` +- [Yarn](https://classic.yarnpkg.com) (`v1`-classic) #### Linux @@ -66,7 +69,8 @@ Depending on your distribution, you will need to run the following command: Then you can run the commands below: -#### Windows / Linux +### Build Setup + ``` bash # install dependencies yarn @@ -84,3 +88,35 @@ 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 +| +---modules +| +---plugins // Vue plugins +| +---router // Vue-Router (for future use) +| \---store // Vuex +| +---migrations +| +---modules +| +\---test +| +---e2e +| +---unit +| +| vue.config.js // vue-cli-plugin-electron-builder (includes electron-builder config) +```