Skip to content

Commit 3fae8b2

Browse files
authored
Added devcontainer (#94)
* Added devcontainer * Updated readme
1 parent 849c031 commit 3fae8b2

File tree

4 files changed

+33
-5
lines changed

4 files changed

+33
-5
lines changed

.devcontainer/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
FROM node:24.7-bookworm

.devcontainer/devcontainer.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "sci-react-ui-devcontainer",
3+
"build": {
4+
"dockerfile": "Dockerfile"
5+
},
6+
"features": {
7+
"ghcr.io/devcontainers/features/common-utils:2.4.2": {
8+
"username": "none",
9+
"upgradePackages": false
10+
},
11+
"ghcr.io/devcontainers-extra/features/pnpm:2": {}
12+
},
13+
"customizations": {
14+
"vscode": {
15+
"extensions": [
16+
"tamasfe.even-better-toml",
17+
"esbenp.prettier-vscode",
18+
"dbaeumer.vscode-eslint"
19+
]
20+
}
21+
},
22+
"runArgs": ["--security-opt=label=type:container_runtime_t"],
23+
"workspaceMount": "source=.,target=/workspace,type=bind",
24+
"workspaceFolder": "/workspace"
25+
}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
/diamondlightsource-sci-react-ui-*.tgz
99
/storybook-static/
1010
/docs
11+
.pnpm-store/
1112

1213
tsconfig.tsbuildinfo

readme.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ Developing
154154

155155
Code can be found at [github.com/DiamondLightSource/sci-react-ui](https://github.com/DiamondLightSource/sci-react-ui).
156156

157-
You'll need `pnpm` installed to build it. See [tools.md](./tools.md) for list of other tools used in this library
157+
You'll need `pnpm` installed to build it. (note: it is automatically installed as a feature if you are using devcontainers)
158+
See [tools.md](./tools.md) for list of other tools used in this library
158159

159160
### Build
160161

@@ -170,7 +171,7 @@ Build with rollup
170171
pnpm run rollup
171172
```
172173

173-
### Storybook
174+
### Storybook
174175

175176
To view the components in Storybook use:
176177

@@ -223,7 +224,7 @@ Steps needed when publishing a new version.
223224
### GitHub release
224225
- GitHub releases and create a new draft release https://github.com/DiamondLightSource/sci-react-ui/releases
225226
- Select the new tag in the "Choose a tag" drop down.
226-
- Copy in the npm url "See https://www.npmjs.com/package/@diamondlightsource/sci-react-ui"
227+
- Copy in the npm url "See https://www.npmjs.com/package/@diamondlightsource/sci-react-ui"
227228
- Copy in the top section of the changelog.
228229
- Press "Publish Release"
229230
- It is now published!
@@ -237,10 +238,10 @@ and create a new section in [./changelog.md](changelog.md) so subsequent change
237238
---------------------
238239
239240
### Added
240-
-
241+
-
241242
242243
### Fixed
243-
-
244+
-
244245
245246
### Changed
246247
-

0 commit comments

Comments
 (0)