Skip to content

Commit 23b77b5

Browse files
committed
test ignore README.md
1 parent fa1b98c commit 23b77b5

File tree

2 files changed

+3
-63
lines changed

2 files changed

+3
-63
lines changed

.github/workflows/ci-build.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ on:
1212
branches:
1313
- main
1414
- develop
15+
paths-ignore:
16+
- 'README.md'
1517

1618
jobs:
1719
lint-and-unit-test:

README.md

Lines changed: 1 addition & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -16,69 +16,7 @@ This project uses [Vite](https://vitejs.dev/).
1616

1717
In the project directory, you can run:
1818

19-
### `yarn install`
20-
21-
This will install all the project dependencies. Running `yarn install` at the top
22-
level initialises all the packages, and you will be ready to start development in any of them!
23-
24-
### `yarn dev`
25-
26-
Runs the `dev` script, which runs the app in development mode.
27-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
28-
29-
### `yarn test`
30-
31-
Runs unit tests for all packages
32-
33-
### `yarn e2e`
34-
35-
Runs e2e tests for all packages
36-
37-
### `yarn lint`
38-
39-
Lints all packages
40-
41-
### `yarn build`
42-
43-
Builds the app for production to the `dist` folder.\
44-
45-
The build is minified and the filenames include the hashes.
46-
Your app is ready to be deployed!
47-
48-
See the section about [building for production](https://vitejs.dev/guide/build.html) for more information.
49-
50-
### `yarn preview`
51-
52-
Deploys a static version of the build from the `dist` directory to port 5001. Use `yarn preview:build` to build and preview it in SciGateway.
53-
54-
For development purposes, use `yarn preview:build:dev` to build in watch mode so that changes are built automatically.
55-
56-
## How to run
57-
58-
### Docker Setup
59-
60-
#### Prerequisites
61-
62-
- Docker installed (if you want to run the microservice inside Docker)
63-
64-
1. Ensure that Docker is installed and running on your machine.
65-
2. Clone the repository and navigate to the project directory:
66-
```bash
67-
git clone git@github.com:ral-facilities/inventory-management-system.git
68-
cd inventory-management-system
69-
```
70-
3. Create a inventory-management-system-settings.json file
71-
```bash
72-
cp public/inventory-management-system-settings.example.json public/inventory-management-system-settings.json
73-
```
74-
4. Build and start the Docker containers:
75-
```bash
76-
docker-compose up
77-
```
78-
The website should now be running inside Docker at http://localhost:3000.
79-
80-
### Local Setup
81-
19+
#
8220
#### Prerequisites
8321

8422
- Node.js (https://nodejs.org/en/) - (LTS version at the time of writing is 16.17.0)

0 commit comments

Comments
 (0)