Skip to content

Commit

Permalink
Add a readme for the web/ subdirectory
Browse files Browse the repository at this point in the history
  • Loading branch information
garronej committed Sep 26, 2023
1 parent 263b714 commit 68cdce1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
22 changes: 22 additions & 0 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<p align="center">
🖥&nbsp;&nbsp;<strong><em>The Web Application</em></strong>&nbsp;&nbsp;🖥️
<br>
<br>
<strong>Interested in Contributing?</strong> Take a look at <a href="https://docs.onyxia.sh/contributing/onyxia">our technical documentation</a>
<br>
<br>
</p>

## 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.

0 comments on commit 68cdce1

Please sign in to comment.