Skip to content

Commit

Permalink
Merge pull request #232 from InseeFrLab/launcher
Browse files Browse the repository at this point in the history
Prepare for the new launcher
  • Loading branch information
garronej authored May 6, 2021
2 parents adf6de0 + eed14bb commit 2255f99
Show file tree
Hide file tree
Showing 52 changed files with 1,102 additions and 544 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Core feature set:

# Contributing

## DEV
## Development

Onyxia-ui relies following open sources backend technologies:
- [Onyxia API](https://github.com/inseefrlab/onyxia-api): For starting containers (RStudio, Jupyter) on demand on a Kubernetes cluster.
Expand Down Expand Up @@ -73,10 +73,14 @@ The is four source directories:
We chose to not make `appConstant` a slice of the store but rather an [object returned by a thunk](https://github.com/InseeFrLab/onyxia-ui/blob/4842ba8fd3c2ae9c03c52b7467d3c77f6e29e9d9/src/app/interfaceWithLib/hooks.ts#L28-L31)
because it stores all the values and functions that never changes (for a specific execution of the app, they changes in between reload of the app though, they are not constant as the environnement variables that are hard codded in the bundle.).
- `src/app/`: The react code.
- `src/app/assets`: Here should be placed the small assets [imported directly from the code](https://github.com/InseeFrLab/onyxia-ui/blob/adf6de0a991fa63e70af17b3fa41849306808dc4/src/app/components/shared/Header.tsx#L7).
For bigger assets like video, you should upload them [here](https://github.com/InseeFrLab/onyxia-ui/releases/tag/assets) and [hard code the url in the code](https://github.com/InseeFrLab/onyxia-ui/blob/adf6de0a991fa63e70af17b3fa41849306808dc4/src/app/components/pages/MySecrets/MySecrets.tsx#L253).
To be able to import other kind of files as urls [like here for example with `.md`](https://github.com/InseeFrLab/onyxia-ui/blob/adf6de0a991fa63e70af17b3fa41849306808dc4/src/app/components/KcApp/getTosMarkdownUrl.ts#L3-L4) you should declare the file extension like it has been done here [here](https://github.com/InseeFrLab/onyxia-ui/blob/adf6de0a991fa63e70af17b3fa41849306808dc4/src/react-app-env.d.ts#L6-L9)
- `src/stories/`: [Storybook](https://storybook.js.org) stories, to develop the react component in isolation.
- `*/tools`: All generic code. Everything that could be externalized to a standalone modules independent from the project.
- `src/js`: Legacy code that hasn't be ported to the new architecture yet.


# Ops

To release a new version, **do not create a tag manually**, simply bump the [`package.json`'s version](https://github.com/InseeFrLab/onyxia-ui/blob/4842ba8fd3c2ae9c03c52b7467d3c77f6e29e9d9/package.json#L4) then push on the default branch,
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@
"tss-react": "^0.0.11",
"type-route": "^0.6.0",
"typeface-roboto": "^0.0.75",
"url-join-ts": "^1.0.5"
"url-join-ts": "^1.0.5",
"urlon": "^3.1.0"
},
"scripts": {
"start": "react-app-rewired start",
Expand Down
5 changes: 5 additions & 0 deletions src/app/assets/svg/Account2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/app/assets/svg/Home2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/app/assets/svg/Trainings2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2255f99

Please sign in to comment.