From 0773607e0c64d41ceb89c1ee21b27661421e3bc6 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Tue, 3 Sep 2024 20:12:01 +0200 Subject: [PATCH 01/14] Update local-setup-ui.md Kim and Gabriel came up with ideas to make this more clear in meeting. --- .../community/contribute/local-setup-ui.md | 55 ++++++++++++------- 1 file changed, 34 insertions(+), 21 deletions(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index 436d9397f..673e9a3a2 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -9,46 +9,59 @@ To get started with conda-store-ui development, there are a couple of options. T ## Pre-requisites -We use [Docker Compose](https://docs.docker.com/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](https://docs.docker.com/compose/install/) +No matter which option you choose, you must first complete the following steps. -1. Fork and clone the [conda-store-ui](https://github.com/conda-incubator/conda-store-ui.git) repository. -2. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version +1. [Install Docker Compose](https://docs.docker.com/compose/install/). We use [Docker Compose](https://docs.docker.com/compose/) to set up the infrastructure. So before starting, ensure that you have Docker Compose installed. +2. [Fork the conda-store-ui repository](https://github.com/conda-incubator/conda-store-ui/fork), then `git clone` it to your computer. +3. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. -## Docker (Recommended) - -Once you have a [local copy of the `conda-store` repository](community/contribute/contribute-code#setup-for-local-development) +## Basic local development (recommended) Running conda-store-ui in Docker is the simplest way to set up your local development environment. -1. Run `yarn run start:docker` to start the entire development stack. -Open your local browser and go to [http://localhost:8000](http://localhost:8000) so see conda-store-ui. -3. You can then log in using the default username of `username` and default password of `password`. +### Install the right version of Yarn + +Yarn is a package manager for JavaScript dependencies. It requires that you [download and install Node.js](https://nodejs.org/en/download/package-manager). Once you have Node.js installed, you can follow the instructions to [install Yarn](https://yarnpkg.com/getting-started/install). + +1. Change to the project root: `cd conda-store-ui` +2. Find out what version of Yarn is required: `cat package.json | grep packageManager` +3. Compare to the version of Yarn that you installed: `yarn --version` + +### Run the UI web app in Docker container + +1. Run `yarn install`. This will download or update the needed JavaScript dependencies into a directory named `node_modules/`. This directory will be exposed in the next step to the `conda-store-ui` Docker container for use at runtime by the Conda Store UI app. +2. Run `yarn run start:docker` to start the entire development stack. This step may take a few minutes the first time you run it. +3. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. +4. You can then log in using the default username of `username` and default password of `password`. **Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. -## Without Docker +## Advanced local development + +For many Conda Store UI development tasks, the basic setup should work. But if you need to work extensively in the UI codebase, then you will probably want to run the conde-store-ui app locally rather than within a Docker container. -This setup still uses Docker for supporting services but runs conda-store-ui locally. +Note: this setup still uses Docker for supporting services (such as the database, server, worker, and cloud storage), but runs conda-store-ui locally. -### Set up your environment +### Set up your Conda environment This project uses [Conda](https://conda.io) for package management. To set up Conda, please see their [installation documentation](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). -1. Change to the project root ` cd conda-store-ui` -2. From the project root create the conda environment `conda env create -f environment_dev.yml` -3. Activate the development environment `conda activate cs-ui-dev-env` -4. Install yarn dependencies `yarn install` -### Run the application +1. Change to the project root: `cd conda-store-ui` +2. From the project root, create the conda environment: `conda env create -f environment_dev.yml` + +### Run the UI app locally -1. Run `yarn run start` and wait for the application to finish starting up -Open your local browser and go to [http://localhost:8000](http://localhost:8000) so see conda-store-ui. -3. You can then log in using the default username of `username` and default password of `password`. +1. Activate the development environment: `conda activate cs-ui-dev-env` +2. Install/update JavaScript dependencies: `yarn install` +3. Run `yarn run start` and wait for the application to finish starting up +4. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. +5. You can then log in using the default username of `username` and default password of `password`. **Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. ## Run the test suite -We currently use jest in order to run unit tests. +We currently use Jest in order to run unit tests. ```bash yarn test // find every test with the .test.[tsx|ts] extension From 91a7bf8470cc1c7d82dfefbc99198b0b78c7a2d9 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 16:00:53 +0200 Subject: [PATCH 02/14] More updates based on feedback and based on work on https://github.com/conda-incubator/conda-store-ui/pull/415/ --- .../community/contribute/local-setup-ui.md | 48 ++++++++----------- 1 file changed, 21 insertions(+), 27 deletions(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index 673e9a3a2..1a111a91a 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -12,35 +12,26 @@ To get started with conda-store-ui development, there are a couple of options. T No matter which option you choose, you must first complete the following steps. 1. [Install Docker Compose](https://docs.docker.com/compose/install/). We use [Docker Compose](https://docs.docker.com/compose/) to set up the infrastructure. So before starting, ensure that you have Docker Compose installed. -2. [Fork the conda-store-ui repository](https://github.com/conda-incubator/conda-store-ui/fork), then `git clone` it to your computer. -3. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. +2. [Fork the conda-store-ui repository](https://github.com/conda-incubator/conda-store-ui/fork) +3. `git clone` the fork to your computer. -## Basic local development (recommended) +## Basic Option (recommended): Run the UI in Docker -Running conda-store-ui in Docker is the simplest way to set up your local development environment. +For basic local development on the UI, running conda-store-ui in Docker is the simplest way to get started. -### Install the right version of Yarn - -Yarn is a package manager for JavaScript dependencies. It requires that you [download and install Node.js](https://nodejs.org/en/download/package-manager). Once you have Node.js installed, you can follow the instructions to [install Yarn](https://yarnpkg.com/getting-started/install). - -1. Change to the project root: `cd conda-store-ui` -2. Find out what version of Yarn is required: `cat package.json | grep packageManager` -3. Compare to the version of Yarn that you installed: `yarn --version` - -### Run the UI web app in Docker container - -1. Run `yarn install`. This will download or update the needed JavaScript dependencies into a directory named `node_modules/`. This directory will be exposed in the next step to the `conda-store-ui` Docker container for use at runtime by the Conda Store UI app. -2. Run `yarn run start:docker` to start the entire development stack. This step may take a few minutes the first time you run it. -3. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. -4. You can then log in using the default username of `username` and default password of `password`. +1. Change your working directory to the project root: `cd conda-store-ui` +2. Optional. Set environment variables. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. If you skip this step, it will be done automatically for you. +3. Run `docker compose --profile local-dev up --build` to start the entire development stack. This step may take a few minutes the first time you run it. +4. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. +5. You can then log in using the default username of `username` and default password of `password`. -**Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. +**Note:** Hot reloading is enabled, so when you make changes to source files (i.e., files under the conda-store-ui/src/ directory), your browser will reload and reflect the changes. -## Advanced local development +## Advanced Option: Run the UI locally (with the rest of the stack in Docker) -For many Conda Store UI development tasks, the basic setup should work. But if you need to work extensively in the UI codebase, then you will probably want to run the conde-store-ui app locally rather than within a Docker container. +For more advanced development on conda-store-ui, the first option might not be sufficient. If you need to work extensively in the UI codebase, then you will probably want to run the UI web app locally rather than within a Docker container. -Note: this setup still uses Docker for supporting services (such as the database, server, worker, and cloud storage), but runs conda-store-ui locally. +Note: this setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. But the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. ### Set up your Conda environment @@ -49,13 +40,16 @@ This project uses [Conda](https://conda.io) for package management. To set up Co 1. Change to the project root: `cd conda-store-ui` 2. From the project root, create the conda environment: `conda env create -f environment_dev.yml` -### Run the UI app locally +### Run conda-store-ui locally (and the rest of the stack in Docker) + +Tip: Make sure are in the project root: `cd conda-store-ui` 1. Activate the development environment: `conda activate cs-ui-dev-env` -2. Install/update JavaScript dependencies: `yarn install` -3. Run `yarn run start` and wait for the application to finish starting up -4. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. -5. You can then log in using the default username of `username` and default password of `password`. +2. Set environment variables. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. +3. Install/update JavaScript dependencies: `yarn install` +4. Run `yarn run start` and wait for the application to finish starting up. This command will run a local dev server for the UI app and run the other Conda Store services in Docker. +5. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. +6. You can then log in using the default username of `username` and default password of `password`. **Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. From cabf62b0313d1717923e1cdc3084bd0b35da94c4 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 16:09:30 +0200 Subject: [PATCH 03/14] reword pre-requisites --- .../community/contribute/local-setup-ui.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index 1a111a91a..a477b647c 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -9,11 +9,19 @@ To get started with conda-store-ui development, there are a couple of options. T ## Pre-requisites -No matter which option you choose, you must first complete the following steps. +This document assumes that you have the following tools set up on your computer: -1. [Install Docker Compose](https://docs.docker.com/compose/install/). We use [Docker Compose](https://docs.docker.com/compose/) to set up the infrastructure. So before starting, ensure that you have Docker Compose installed. -2. [Fork the conda-store-ui repository](https://github.com/conda-incubator/conda-store-ui/fork) -3. `git clone` the fork to your computer. +- Docker Compose (which requires Docker) +- Git + +You also need to have: + +- A GitHub.com account + +Once you have all of those things, then you need to: + +1. [Fork the conda-store-ui repository](https://github.com/conda-incubator/conda-store-ui/fork) +2. `git clone` the fork to your computer. ## Basic Option (recommended): Run the UI in Docker From b2beb2fac243e50c056835b48b2fdfe776589042 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 16:20:04 +0200 Subject: [PATCH 04/14] forgot corepack --- docusaurus-docs/community/contribute/local-setup-ui.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index a477b647c..f91534bc6 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -54,10 +54,11 @@ Tip: Make sure are in the project root: `cd conda-store-ui` 1. Activate the development environment: `conda activate cs-ui-dev-env` 2. Set environment variables. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. -3. Install/update JavaScript dependencies: `yarn install` -4. Run `yarn run start` and wait for the application to finish starting up. This command will run a local dev server for the UI app and run the other Conda Store services in Docker. -5. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. -6. You can then log in using the default username of `username` and default password of `password`. +3. Set the package manager to match package.json (`packageManager`): `corepack enable` +4. Install/update JavaScript dependencies: `yarn install` +5. Run `yarn run start` and wait for the application to finish starting up. This command will run a local dev server for the UI app and run the other Conda Store services in Docker. +6. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. +7. You can then log in using the default username of `username` and default password of `password`. **Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. From e70180486bd380dbfa6726eca66a0ca8e63169e4 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 16:20:55 +0200 Subject: [PATCH 05/14] typo --- docusaurus-docs/community/contribute/local-setup-ui.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index f91534bc6..a98f8604a 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -50,7 +50,7 @@ This project uses [Conda](https://conda.io) for package management. To set up Co ### Run conda-store-ui locally (and the rest of the stack in Docker) -Tip: Make sure are in the project root: `cd conda-store-ui` +Tip: Make sure you are in the project root: `cd conda-store-ui` 1. Activate the development environment: `conda activate cs-ui-dev-env` 2. Set environment variables. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. From 92ca0d1a9a955081e40f35699f33833e6b101626 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 10:03:14 -0500 Subject: [PATCH 06/14] Update docusaurus-docs/community/contribute/local-setup-ui.md Co-authored-by: Kim Pevey --- docusaurus-docs/community/contribute/local-setup-ui.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index a98f8604a..973ed2863 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -39,7 +39,7 @@ For basic local development on the UI, running conda-store-ui in Docker is the s For more advanced development on conda-store-ui, the first option might not be sufficient. If you need to work extensively in the UI codebase, then you will probably want to run the UI web app locally rather than within a Docker container. -Note: this setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. But the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. +**Note:** this setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. However, the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. ### Set up your Conda environment From fda6d9a24992dfe02b0273c0513720ec3e5c4d17 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 10:05:21 -0500 Subject: [PATCH 07/14] Update docusaurus-docs/community/contribute/local-setup-ui.md Co-authored-by: Tania Allard --- docusaurus-docs/community/contribute/local-setup-ui.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index 973ed2863..da2537d49 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -53,7 +53,7 @@ This project uses [Conda](https://conda.io) for package management. To set up Co Tip: Make sure you are in the project root: `cd conda-store-ui` 1. Activate the development environment: `conda activate cs-ui-dev-env` -2. Set environment variables. Copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. +2. Set environment variables: copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. 3. Set the package manager to match package.json (`packageManager`): `corepack enable` 4. Install/update JavaScript dependencies: `yarn install` 5. Run `yarn run start` and wait for the application to finish starting up. This command will run a local dev server for the UI app and run the other Conda Store services in Docker. From 8c9587f161046f57b86949892bc4d3cf481e1d2f Mon Sep 17 00:00:00 2001 From: gabalafou Date: Wed, 4 Sep 2024 17:12:11 +0200 Subject: [PATCH 08/14] move testing into advanced option --- docusaurus-docs/community/contribute/local-setup-ui.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index da2537d49..fb96303c8 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -62,9 +62,9 @@ Tip: Make sure you are in the project root: `cd conda-store-ui` **Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. -## Run the test suite +### Run the test suite -We currently use Jest in order to run unit tests. +If you chose the advanced option for local development, you will be able to run the tests locally. We currently use Jest in order to run unit tests. ```bash yarn test // find every test with the .test.[tsx|ts] extension From 0f5258b9ce7cc448f58b380d2665d1c911a2af5e Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 6 Sep 2024 10:14:04 -0500 Subject: [PATCH 09/14] Update docusaurus-docs/community/contribute/local-setup-ui.md --- docusaurus-docs/community/contribute/local-setup-ui.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index fb96303c8..e1051ed4d 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -54,7 +54,7 @@ Tip: Make sure you are in the project root: `cd conda-store-ui` 1. Activate the development environment: `conda activate cs-ui-dev-env` 2. Set environment variables: copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. -3. Set the package manager to match package.json (`packageManager`): `corepack enable` +3. Run: `corepack enable`. Corepack comes with Node.js which was installed when you set up your Conda dev environment. Running `corepack enable` ensures that the version of Yarn that you use in the next step matches the version required by the repo (see package.json > packageManager). Yarn also comes with Node.js but is not automatically added to your environment's path until you run `corepack enable`. 4. Install/update JavaScript dependencies: `yarn install` 5. Run `yarn run start` and wait for the application to finish starting up. This command will run a local dev server for the UI app and run the other Conda Store services in Docker. 6. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. From 94fd52b058ef05f6b03d8f23ee1120e9da351d0e Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 6 Sep 2024 10:14:46 -0500 Subject: [PATCH 10/14] Update docusaurus-docs/community/contribute/local-setup-ui.md Co-authored-by: Tania Allard --- docusaurus-docs/community/contribute/local-setup-ui.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index e1051ed4d..def464a93 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -50,7 +50,11 @@ This project uses [Conda](https://conda.io) for package management. To set up Co ### Run conda-store-ui locally (and the rest of the stack in Docker) -Tip: Make sure you are in the project root: `cd conda-store-ui` +:::tip + +Make sure you are in the project root: `cd conda-store-ui` + +::: 1. Activate the development environment: `conda activate cs-ui-dev-env` 2. Set environment variables: copy `.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 it in the `.env` file by setting the `CONDA_STORE_SERVER_VERSION` variable to the desired version. From 6b3ebb6f018a20601135d7d147d40d25c477f6fd Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 6 Sep 2024 10:14:55 -0500 Subject: [PATCH 11/14] Update docusaurus-docs/community/contribute/local-setup-ui.md Co-authored-by: Tania Allard --- docusaurus-docs/community/contribute/local-setup-ui.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index def464a93..2048a8252 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -33,7 +33,11 @@ For basic local development on the UI, running conda-store-ui in Docker is the s 4. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. 5. You can then log in using the default username of `username` and default password of `password`. -**Note:** Hot reloading is enabled, so when you make changes to source files (i.e., files under the conda-store-ui/src/ directory), your browser will reload and reflect the changes. +:::note + +Hot reloading is enabled, so when you make changes to source files (i.e., files under the conda-store-ui/src/ directory), your browser will reload and reflect the changes. + +::: ## Advanced Option: Run the UI locally (with the rest of the stack in Docker) From a942ee33b4b029a77e6b42c199eb91c0a0e048a9 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 6 Sep 2024 10:15:05 -0500 Subject: [PATCH 12/14] Update docusaurus-docs/community/contribute/local-setup-ui.md Co-authored-by: Tania Allard --- docusaurus-docs/community/contribute/local-setup-ui.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index 2048a8252..ceebf1554 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -68,7 +68,11 @@ Make sure you are in the project root: `cd conda-store-ui` 6. Open your local browser and go to [http://localhost:8000](http://localhost:8000) to see conda-store-ui. 7. You can then log in using the default username of `username` and default password of `password`. -**Note:** Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. +:::note + +Hot reloading is enabled, so when you make changes to source files, your browser will reload and reflect the changes. + +::: ### Run the test suite From d5e1d90b8f360b66ca3d14ad2b36d2c1cd2974b7 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 6 Sep 2024 10:17:12 -0500 Subject: [PATCH 13/14] Update docusaurus-docs/community/contribute/local-setup-ui.md --- docusaurus-docs/community/contribute/local-setup-ui.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index ceebf1554..0e3120ba7 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -43,7 +43,11 @@ Hot reloading is enabled, so when you make changes to source files (i.e., files For more advanced development on conda-store-ui, the first option might not be sufficient. If you need to work extensively in the UI codebase, then you will probably want to run the UI web app locally rather than within a Docker container. -**Note:** this setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. However, the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. +:::note + +this setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. However, the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. + +::: ### Set up your Conda environment From e77173f5a5bf8da4f0c8b5706ea8125f547a6820 Mon Sep 17 00:00:00 2001 From: gabalafou Date: Fri, 6 Sep 2024 10:17:45 -0500 Subject: [PATCH 14/14] Update docusaurus-docs/community/contribute/local-setup-ui.md --- docusaurus-docs/community/contribute/local-setup-ui.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus-docs/community/contribute/local-setup-ui.md b/docusaurus-docs/community/contribute/local-setup-ui.md index 0e3120ba7..3d56fd458 100644 --- a/docusaurus-docs/community/contribute/local-setup-ui.md +++ b/docusaurus-docs/community/contribute/local-setup-ui.md @@ -45,7 +45,7 @@ For more advanced development on conda-store-ui, the first option might not be s :::note -this setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. However, the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. +This setup still uses Docker to run the rest of the Conda Store stack. That means that the Conda Store database, server, worker, and storage services will all run in Docker containers. However, the frontend web app (conda-store-ui) will run locally (not in a Docker container) with this setup. :::