Skip to content

Commit

Permalink
Migration (#43)
Browse files Browse the repository at this point in the history
* core add

Signed-off-by: Courtney Gosselin <[email protected]>

* Run codemods

Signed-off-by: Courtney Gosselin <[email protected]>

* Variant prop change

Signed-off-by: Courtney Gosselin <[email protected]>

* link-underline-hover change

Signed-off-by: Courtney Gosselin <[email protected]>

* Migration to MUI5

Signed-off-by: Courtney Gosselin <[email protected]>

* Dataset dropdown fixed

Signed-off-by: Courtney Gosselin <[email protected]>

* borders and source map error

Signed-off-by: Courtney Gosselin <[email protected]>

* Update env.development

Signed-off-by: Courtney Gosselin <[email protected]>

* Update readme with versions required to run MUI5

Signed-off-by: Courtney Gosselin <[email protected]>

* Fix env duplicate

Signed-off-by: Courtney Gosselin <[email protected]>

* updated .eslintrc

* updated dependencies

Signed-off-by: Courtney Gosselin <[email protected]>
Co-authored-by: Courtney Gosselin <[email protected]>
Co-authored-by: Javier Castillo-Arnemann <[email protected]>
  • Loading branch information
3 people authored Sep 7, 2022
1 parent d0c3b7f commit 19730e9
Show file tree
Hide file tree
Showing 76 changed files with 39,190 additions and 20,596 deletions.
1 change: 1 addition & 0 deletions .env.development
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ REACT_APP_CANDIG_SERVER = ''
REACT_APP_FEDERATION_API_SERVER=''
REACT_APP_BASE_NAME=''
REACT_APP_SITE_LOCATION = ''
GENERATE_SOURCEMAP=false
REACT_APP_HTSGET_SERVER = ''
1 change: 1 addition & 0 deletions .env.production
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ REACT_APP_CANDIG_SERVER = ''
REACT_APP_FEDERATION_API_SERVER=''
REACT_APP_BASE_NAME=''
REACT_APP_SITE_LOCATION = ''
GENERATE_SOURCEMAP=false
REACT_APP_HTSGET_SERVER = ''
6 changes: 4 additions & 2 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"browser": true,
"es2021": true
},
"extends": ["airbnb", "prettier", "plugin:jsx-a11y/recommended", "plugin:react-hooks/recommended"],
"extends": ["airbnb", "prettier", "plugin:jsx-a11y/recommended", "plugin:react-hooks/recommended", "plugin:react/recommended", "plugin:react/jsx-runtime"],
"settings": {
"import/resolver": {
"node": {
Expand Down Expand Up @@ -32,6 +32,7 @@
"import/order": 0,
"no-console": 0,
"jsx-a11y/anchor-is-valid": 0,
"prefer-destructuring": 0,
"no-shadow": 0,
"no-unused-vars": [
1,
Expand All @@ -47,7 +48,8 @@
"singleQuote": true,
"trailingComma": "none",
"tabWidth": 4,
"useTabs": false
"useTabs": false,
"endOfLine": "auto"
}
]
}
Expand Down
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ A data analytics and visualization portal for CanDIG Services. Is built off the

## Setup Development Server

- Node:v17.7.1
- npm: 8.5.2
- MUI: V5

There was a migration from V4 - V5 of MUI following https://mui.com/material-ui/guides/migration-v4/

### Installation

Navigate to route folder of the project and do an npm install
Expand All @@ -16,18 +22,18 @@ cd candig-data-portal
npm install
```


The file `.env.development` is where you specify API Servers and site-specific variables.

- `REACT_APP_KATSU_API_SERVER`: Path to the Katsu API.
- `REACT_APP_CANDIG_SERVER`: Path to the candig-server API.
- `REACT_APP_BASE_NAME`: The prepending path of your server. For example, if you would like your app to be available at `/v2/data-portal`, you should specify the aforementioned value here. By default, the app will be running at root.
- `REACT_APP_SITE_LOCATION`: If you specify `BCGSC` or `UHN`, the app will display the logo of respective institution.
- `REACT_APP_KATSU_API_SERVER`: Path to the Katsu API.
- `REACT_APP_CANDIG_SERVER`: Path to the candig-server API.
- `REACT_APP_BASE_NAME`: The prepending path of your server. For example, if you would like your app to be available at `/v2/data-portal`, you should specify the aforementioned value here. By default, the app will be running at root.
- `REACT_APP_SITE_LOCATION`: If you specify `BCGSC` or `UHN`, the app will display the logo of respective institution.
- `GENERATE_SOURCEMAP`: Removes map fodlers from build when set to false

After this you can start the application by running **npm start**

Note that if you change any of the variables above, you need to restart your server for them to be in effect.

```
npm start
```
Expand All @@ -39,7 +45,7 @@ Compiled successfully!
You can now view candig-data-portal in the browser.
Local: http://localhost:3000
Local: http://localhost:3000
On Your Network: http://192.168.29.77:3000
Note that the development build is not optimized.
Expand All @@ -65,4 +71,3 @@ npm run build
```

This will produce a static folder `/build` to be served with any static file server.

Loading

0 comments on commit 19730e9

Please sign in to comment.