diff options
-rw-r--r-- | README.md | 29 |
1 files changed, 17 insertions, 12 deletions
@@ -57,6 +57,14 @@ You can find the installers in the [latest release](https://github.com/getferdi/ | |||
57 | 57 | ||
58 | #### Install OS dependencies | 58 | #### Install OS dependencies |
59 | 59 | ||
60 | ##### Node.js | ||
61 | |||
62 | Please make sure you are running NodeJS v10 ([v10.16.3](https://nodejs.org/dist/v10.16.3/) suggested). Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278). | ||
63 | |||
64 | ##### Git | ||
65 | |||
66 | The version [2.23.0](https://github.com/git-for-windows/git/releases/tag/v2.23.0.windows.1) for Git is working fine for development. You can then use the console from Git to do the development procedure. | ||
67 | |||
60 | ##### Debian/Ubuntu | 68 | ##### Debian/Ubuntu |
61 | 69 | ||
62 | ```bash | 70 | ```bash |
@@ -79,23 +87,14 @@ $ npm install --global windows-build-tools --vs2015 // Windows 7 | |||
79 | #### Clone repository with submodule | 87 | #### Clone repository with submodule |
80 | 88 | ||
81 | ```bash | 89 | ```bash |
82 | $ git clone git@github.com:getferdi/ferdi.git | 90 | $ git clone https://github.com/getferdi/ferdi.git |
83 | $ cd getferdi | 91 | $ cd ferdi |
92 | $ git status | ||
84 | $ git submodule update --init --recursive | 93 | $ git submodule update --init --recursive |
85 | ``` | 94 | ``` |
86 | 95 | ||
87 | It is important you execute the last command to get the required submodules (recipes, server). | 96 | It is important you execute the last command to get the required submodules (recipes, server). |
88 | 97 | ||
89 | #### Use right NodeJS version | ||
90 | |||
91 | Please make sure you are running NodeJS v10 (v10.16.3 suggested). Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278). | ||
92 | |||
93 | #### Fix native modules to match current electron node version | ||
94 | |||
95 | ```bash | ||
96 | $ npm run rebuild | ||
97 | ``` | ||
98 | |||
99 | ### Install dependencies | 98 | ### Install dependencies |
100 | 99 | ||
101 | Run the following command to install all dependencies, and link sibling modules with Ferdi. | 100 | Run the following command to install all dependencies, and link sibling modules with Ferdi. |
@@ -106,6 +105,12 @@ $ npx lerna bootstrap | |||
106 | 105 | ||
107 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. | 106 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. |
108 | 107 | ||
108 | ### Fix native modules to match current electron node version | ||
109 | |||
110 | ```bash | ||
111 | $ npm run rebuild | ||
112 | ``` | ||
113 | |||
109 | ### Start development app | 114 | ### Start development app |
110 | 115 | ||
111 | Run these two commands **simultaneously** in different console tabs: | 116 | Run these two commands **simultaneously** in different console tabs: |