Skip to content

Commit

Permalink
Merge pull request #259 from steff456/fix-url
Browse files Browse the repository at this point in the history
Update repository URLs
  • Loading branch information
anirrudh authored Aug 7, 2023
2 parents 7308e18 + 91876ed commit 216bb3d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# conda-store-ui
Graphical User Interface for [conda-store](https://github.com/conda-incubator/conda-store)
Graphical User Interface for [conda-store](https://github.com/conda-incubator/conda-store)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/conda-incubator/conda-store-ui/build.yml?label=Build&logo=GitHub)
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/conda-incubator/conda-store-ui/deploy.yml?event=push&label=Deploy&logo=GitHub)
Expand All @@ -11,23 +11,23 @@ Graphical User Interface for [conda-store](https://github.com/conda-incubator/co

## Get Started

To learn how to use conda-store-ui alongisde conda-store, please visit our [documentation](https://quansight.github.io/conda-store-ui/).
To learn how to use conda-store-ui alongisde conda-store, please visit our [documentation](https://conda-incubator.github.io/conda-store-ui/).

## Related Work

conda-store-ui is an addon to [conda-store](https://github.com/conda-incubator/conda-store). If you're looking for the JupyterLab Extension, you can find it at [conda-store-jupyterlab](https://github.com/Quansight/conda-store).
conda-store-ui is an addon to [conda-store](https://github.com/conda-incubator/conda-store). If you're looking for the JupyterLab Extension, you can find it at [conda-store-jupyterlab](https://github.com/conda-incubator/conda-store).

## Developing

For developing this application, we use Docker Compose for setting up the infrastructure, and conda as the package manager for node/yarn. Note
that you can use any method you wish to use yarn/nodejs.
We use Docker Compose to set up the infrastructure and conda as the package manager for node/yarn. Note
that you can use any method you wish to use yarn/nodejs.

1) Clone this repo and from root, start docker compose:

```bash
git clone https://github.com/conda-incubator/conda-store-ui.git
cd conda-store-ui
docker-compose -f docker-compose-dev.yml up --build
docker-compose -f docker-compose-dev.yml up --build
```

2) Then, install yarn/node.js.
Expand Down Expand Up @@ -62,6 +62,10 @@ In order to create a new version of this package, follow these steps:

Latest Release: https://libraries.io/npm/@conda-store%2Fconda-store-ui

## Code of Conduct

To guarantee a welcoming and friendly community, we require all community members to follow our [Code of Conduct](https://github.com/conda-incubator/governance/blob/main/CODE_OF_CONDUCT.md).

## License

conda-store-ui is developed under the [BSD-3 LICENSE](./LICENSE).
14 changes: 7 additions & 7 deletions src/docs/markdown/INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Installation
# Installation

There are multiple ways to utilize `conda-store-ui`. Here, we'll be looking at the supported methods of installation.

## Local Installation

**Note** that for installing from source, you will stil need a running conda-store somewhere. The easiest way to do this locally is by running conda-store with docker-compose.
**Note** that for installing from source, you will stil need a running conda-store somewhere. The easiest way to do this locally is by running conda-store with docker-compose.

1) Clone the [conda-store-ui](https://github.com/Quansight/conda-store-ui.git) repository.
1) Clone the [conda-store-ui](https://github.com/conda-incubator/conda-store-ui.git) repository.

2) If you have an instance of conda-store you plan to connect to, skip this step. Otherwise, start it using docker.

```bash
git clone https://github.com/Quansight/conda-store-ui.git
git clone https://github.com/conda-incubator/conda-store-ui.git
cd conda-store-ui
docker-compose -f docker-compose-dev.yml up --build
```
Expand All @@ -36,9 +36,9 @@ yarn run start

## Docker Installation

We provide a oneshot docker-compose file for development purposes. This has been tested with the latest version of docker desktop and docker-compose, and it provides a fresh instance of conda-store.
We provide a oneshot docker-compose file for development purposes. This has been tested with the latest version of docker desktop and docker-compose, and it provides a fresh instance of conda-store.

1) Clone the [conda-store-ui](https://github.com/Quansight/conda-store-ui.git) repository.
1) Clone the [conda-store-ui](https://github.com/conda-incubator/conda-store-ui.git) repository.

2) Start the docker-compose stack.

Expand All @@ -49,6 +49,6 @@ docker compose up --build

3) Access conda-store-ui at [localhost](http://localhost/)

4) Login by locating the login icon, and clicking on it. The default login combination is `username/password`.
4) Login by locating the login icon, and clicking on it. The default login combination is `username/password`.


4 changes: 2 additions & 2 deletions src/docs/markdown/START.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For a local deployment, we recommend that you use our provided docker compose fi
### 1) Clone the repository and `cd` into the root

```bash
git clone https://github.com/Quansight/conda-store-ui.git
git clone https://github.com/conda-incubator/conda-store-ui.git
cd conda-store-ui
```

Expand All @@ -25,6 +25,6 @@ docker compose up --build

Since this Dockerfile came bundled with conda-store, all that's left to worry about is authenticating to the server.

### 4) Login by locating the login icon, and clicking on it.
### 4) Login by locating the login icon, and clicking on it.

**Note** The default login combination is `username/password`

0 comments on commit 216bb3d

Please sign in to comment.