diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 000000000..c985ed047 Binary files /dev/null and b/.DS_Store differ diff --git a/web/README.md b/web/README.md new file mode 100644 index 000000000..340fb7139 --- /dev/null +++ b/web/README.md @@ -0,0 +1,22 @@ +

+ 🖥  The Web Application  🖥️ +
+
+ Interested in Contributing? Take a look at our technical documentation +
+
+

+ +## Overview + +This repository contains the source code for the Docker image [inseefrlab/onyxia-web](https://hub.docker.com/r/inseefrlab/onyxia-web). + +## Architecture + +`onyxia-web` is a Single Page Application (SPA) that runs entirely in the user's browser and is delivered as static files. + +## Project Structure + +- **UI Layer:** This project utilizes React, but solely as a UI library. The React-specific code is isolated to [src/ui](./src/ui). + +- **Core Logic:** The bulk of the application's functionality resides in [src/core](./src/core). Importantly, the core logic is entirely agnostic to React.