Information | Links |
---|---|
Project | |
Wofklows | |
Releases |
conda-store-ui is an add-on Graphical User Interface to conda-store. If you're looking for the JupyterLab Extension, you can find it at jupyterlab-conda-store
To learn how to use conda-store-ui alongside conda-store, please visit the conda-store-ui documentation.
To get started with conda-store-ui development, there are a couple of options, depending on the type of changes you are working on. This guide will help you to set up your local development environment.
Before setting up conda-store-ui, you must prepare your environment.
We use Docker Compose to set up the infrastructure before starting ensure that you have docker-compose installed. If you need to install docker-compose, please see their installation documentation
.env.example
to .env
. All default settings should work, but if you want to test against a different version of conda-store-server, you can specify if in the .env
file by setting the CONDA_STORE_SERVER_VERSION
variable to the desired version. Refer to the Configuration documentation for more information on the .env
file.Running conda-store-ui in Docker is the most straightforward way to set up your local development environment.
yarn run start:docker
to start the entire development stack.username
and default password of password
.Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes.
This setup still uses Docker for supporting services but runs conda-store-ui locally.
This project uses Conda for package management. To set up Conda, please see their installation documentation.
cd conda-store-ui
conda env create -f environment_dev.yml
conda activate cs-ui-dev-env
yarn install
yarn run start
and wait for the application to finish starting upusername
and default password of password
.Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes.
To create a new version of this package, follow these steps:
package.json
(we use CalVer: YYYY.MM.releaseNumber
starting with releaseNumber=1
)2023.9.1
Choose a Tag:
dropdown, type in the release name (e.g., 2023.9.1
) and click "Create new tag"🔗 You can find more details about out release process and versioning approach in our Maintenance docs.
[^github-activity]: If you wish, use github-activity
to generate a Changelog, e.g. github-activity conda-incubator/conda-store-ui --since 2023.9.1 --until 2023.10.1 --auth <GH personal access token>
This repo contains two types of tests: Jest and Playwright
To run the Jest tests, run the following command:
yarn test
Steps to install and set up:
conda env create -f environment_dev.yml
conda activate cs-ui-dev-env
playwright install chromium
cp .env.example .env
yarn install --immutable
yarn build
To run the tests, you will need to run commands in two separate terminal windows or tabs.
Steps to run:
conda activate cs-ui-dev-env
yarn start
conda activate cs-ui-dev-env
pytest
If you need to debug, try replacing the last command with:
PWDEBUG=1 pytest
Note: PW stands for Playwright. PWDEBUG=1
puts Playwright in debug
mode.
To guarantee a welcoming and friendly community, we require all community members to follow our Code of Conduct.
conda-store-ui is developed under the BSD-3 LICENSE.