SharingHub UI

Table of contents

• Environment setup
• Development
• Production
  • Local build
  • Docker image

Environment setup

You will need:

• Node v18
• NPM 9.
• Python 3.11 or later

Setup the environment:

npm install

Install the pre-commit hooks:

python3 -m pip install pre-commit
pre-commit install --install-hooks

Development

Lint

The linting is managed by pre-commit, but you can run it with:

pre-commit run --all-files

Run the development server

npm start -- --apiUrl="http://localhost:8000/api/" --docsUrl="http://localhost:5000/"

Production

Local build

Build the web UI with:

npm run build

Docker image

Build the image:

docker build . -t sharinghub-ui:latest --build-arg VERSION=$(git rev-parse --short HEAD)

Copyright and License

Copyright 2024 CS GROUP - France

SharingHub UI is an open source software, distributed under the Apache License 2.0. See the LICENSE file for more information.