Skip to content

Commit

Permalink
Remove step for pnpm global install in README
Browse files Browse the repository at this point in the history
  • Loading branch information
fabcor-maxiv committed Oct 6, 2023
1 parent 9dfd0c6 commit a505ff2
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,21 +95,20 @@ conda env create -f conda-environment.yml --name another_name
conda activate mxcubeweb
```

### 5. Install remaining dependencies
### 5. Install MXCuBE-Web back-end dependencies

```
poetry install
npm install --global pnpm@8
```

### 6. Install front-end dependencies and build the UI
### 6. Install MXCuBE-Web front-end dependencies and build the web front-end UI

```
pnpm --prefix ui install
pnpm --prefix ui build
```

### 7. Starting the MXCuBE server
### 7. Starting the MXCuBE-Web server

```
# Activate the conda environement and start the Redis server (if not already running)
Expand All @@ -132,7 +131,7 @@ _The test username is `idtest0` and the password can be any string (except `wron

The client is not built if nothing appears or you get a "404 page not found" error when browsing localhost:8081. Follow the instructions in step 6 "Install front-end dependencies and build the UI" to build a client .

### 9. Installing MXCUBE-Web for development
### 9. Installing additional MXCUBE-Web dependencies for development

Please read the [contributing guidelines](https://github.com/mxcube/mxcubeweb/blob/develop/CONTRIBUTING.md) before getting started with the development.

Expand All @@ -157,7 +156,7 @@ pip install -e .
pip install -e .
```

#### 9.1 Running the back-end tests
#### 9.1 Running the MXCuBE-Web back-end tests

The tests are located in the test folder and are executed with `pytest`.

Expand All @@ -174,7 +173,7 @@ pytest
_The output should look something like the following:_
![image](https://github.com/mxcube/mxcubeweb/assets/4331447/379fa92e-566b-47e5-8522-cacfa9f8de2d)

#### 9.2 Starting the front-end development server
#### 9.2 Starting the MXCuBE-Web front-end development server

The front-end development server listens to changes on the file system and re-builds the UI when changes are made. This makes it very easy and fast to see how changes affect the UI. The development server listens on port **3000**.

Expand Down

0 comments on commit a505ff2

Please sign in to comment.