|
7 | 7 |
|
8 | 8 | 1. [Docker](https://www.docker.com/get-started).
|
9 | 9 | 2. [mysql 8](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/).
|
10 |
| - 3. [Java 11](https://dev.java/download/) SDK. |
| 10 | + 3. [Java 17](https://dev.java/download/) SDK. |
11 | 11 | 4. [Node.js](https://nodejs.org): We use Node to run a development web server
|
12 | 12 | and build the project. Depending on your system, you can install Node either
|
13 | 13 | from source or as a pre-packaged bundle. The version of node we are using can
|
|
24 | 24 |
|
25 | 25 | 5. [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/)
|
26 | 26 |
|
27 |
| -2. After installing Node and yarn, you should be able to run the following command |
| 27 | +2. Run the brew command for the Mac in the [compiling section](https://github.com/Automattic/node-canvas?tab=readme-ov-file#compiling) of the node-canvas readme. For other systems, please see [compiling section](https://github.com/Automattic/node-canvas?tab=readme-ov-file#compiling) for instructions. |
| 28 | + |
| 29 | +```sh |
| 30 | +brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman |
| 31 | +``` |
| 32 | + |
| 33 | +3. After installing Node and yarn, you should be able to run the following command |
28 | 34 | to install development tools. You will only need to run this command when
|
29 | 35 | dependencies change in [package.json](package.json).
|
30 | 36 |
|
|
34 | 40 |
|
35 | 41 | We use yarn scripts and [Webpack](https://webpack.js.org/) as our build system.
|
36 | 42 |
|
37 |
| -3. If you are using redis as a cache, you will have to launch a cache server. |
| 43 | +4. If you are using redis as a cache, you will have to launch a cache server (Optional). |
38 | 44 |
|
39 | 45 | - To start your cache server, run:
|
40 | 46 |
|
|
53 | 59 | See [here](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-caching.html#boot-features-caching-provider-none)
|
54 | 60 | for details.
|
55 | 61 |
|
56 |
| -4. Configure Keycloak and Google SSO |
| 62 | +5. Configure Keycloak and Google SSO |
57 | 63 |
|
58 | 64 | To log in to your app, you'll need to have [Keycloak](https://keycloak.org)
|
59 | 65 | up and running.
|
|
114 | 120 | scope: openid,profile,email
|
115 | 121 | ```
|
116 | 122 |
|
117 |
| -5. Configure Firebase |
| 123 | +6. Configure Firebase |
118 | 124 |
|
119 | 125 | 1. Go to [Firebase Console](https://console.firebase.google.com/) and create
|
120 | 126 | a new project
|
|
155 | 161 | 17. Expand **Build** and click **Authentication**
|
156 | 162 | 18. Click the **Sign-in method** section and add email/password provider
|
157 | 163 |
|
158 |
| -6. Verify that your mysql configuration in [application-dev.yaml](src/main/resources/config/application-dev.yml) |
| 164 | +7. Verify that your mysql configuration in [application-dev.yaml](src/main/resources/config/application-dev.yml) |
159 | 165 | is correct for you mysql server instance.
|
160 | 166 |
|
161 | 167 | ```yaml
|
|
166 | 172 | password: root
|
167 | 173 | ```
|
168 | 174 |
|
169 |
| -7. Run the application (Don't login just yet) |
| 175 | +8. Run the application (Don't login just yet) |
170 | 176 |
|
171 | 177 | - Note your a oncokb_curation schema will be created in your mysql database.
|
172 | 178 | Data will also be seeded for it.
|
|
175 | 181 | ./mvnw
|
176 | 182 | ```
|
177 | 183 |
|
178 |
| -8. Wait until the server is listening to requests and is able to redirect you to |
| 184 | +9. Wait until the server is listening to requests and is able to redirect you to |
179 | 185 | the login screen. (server url defaults to `http://localhost:9090`)
|
180 | 186 |
|
181 |
| -9. Add a login for yourself into your mysql instance. Replace <your_email> |
182 |
| - with your gmail email address. |
183 |
| - |
184 |
| - ```sql |
185 |
| - INSERT INTO `oncokb_curation`.`user` |
186 |
| - ( |
187 |
| - `login`, |
188 |
| - `email`, |
189 |
| - `created_by`, |
190 |
| - `activated`) |
191 |
| - VALUES |
192 |
| - ('<your_email>', |
193 |
| - '<your_email>', |
194 |
| - 'SYSTEM', |
195 |
| - 1); |
196 |
| -
|
197 |
| - SET @UserID = (SELECT Id |
198 |
| - FROM `oncokb_curation`.`user` |
199 |
| - WHERE email = '<your_email>'); |
200 |
| -
|
201 |
| - INSERT INTO `oncokb_curation`.`user_authority` |
202 |
| - (user_id, authority_name) |
203 |
| - VALUES |
204 |
| - (@UserId, 'ROLE_ADMIN'), |
205 |
| - (@UserId, 'ROLE_DEV'), |
206 |
| - (@UserId, 'ROLE_CURATOR'), |
207 |
| - (@UserId, 'ROLE_USER'); |
| 187 | +10. Add a login for yourself into your mysql instance. Replace <your_email> |
| 188 | + with your gmail email address. |
| 189 | + |
| 190 | +```sql |
| 191 | +INSERT INTO `oncokb_curation`.`user` |
| 192 | +( |
| 193 | + `login`, |
| 194 | + `email`, |
| 195 | + `created_by`, |
| 196 | + `activated`) |
| 197 | +VALUES |
| 198 | + ('<your_email>', |
| 199 | + '<your_email>', |
| 200 | + 'SYSTEM', |
| 201 | + 1); |
| 202 | +
|
| 203 | +SET @UserID = (SELECT Id |
| 204 | + FROM `oncokb_curation`.`user` |
| 205 | + WHERE email = '<your_email>'); |
| 206 | +
|
| 207 | +INSERT INTO `oncokb_curation`.`user_authority` |
| 208 | + (user_id, authority_name) |
| 209 | + VALUES |
| 210 | + (@UserId, 'ROLE_ADMIN'), |
| 211 | + (@UserId, 'ROLE_DEV'), |
| 212 | + (@UserId, 'ROLE_CURATOR'), |
| 213 | + (@UserId, 'ROLE_USER'); |
208 | 214 |
|
209 |
| - ``` |
| 215 | +``` |
210 | 216 |
|
211 |
| -10. Login to curation! |
| 217 | +11. Login to curation! |
212 | 218 |
|
213 | 219 | ## Building for production
|
214 | 220 |
|
|
0 commit comments