Skip to content

Commit d4cdc79

Browse files
committed
docs: Add readme for dev container
1 parent be7119a commit d4cdc79

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This repository contains the code of the new _openSenseMap_ frontend running at
66
Originally, the _openSenseMap_ was built as part of the bachelor thesis of
77
[@mpfeil](https://github.com/mpfeil) at the ifgi (Institute for Geoinformatics,
88
University of Münster). Between 2016 and 2022 development was partly funded by
9-
the German Ministry of Education and Research (BMBF) in the projets senseBox and
10-
senseBox Pro. This version has been developed by
9+
the German Ministry of Education and Research (BMBF) in the projects senseBox
10+
and senseBox Pro. This version has been developed by
1111
[@mpfeil](https://github.com/mpfeil) and
1212
[@freds-dev](https://github.com/freds-dev).
1313

@@ -25,6 +25,13 @@ instructions:
2525
- [git](https://git-scm.com/) >= 2.38.0
2626
- [Docker](https://www.docker.com) >= 27.0.0
2727

28+
#### Developing inside a DevContainer
29+
30+
- [Visual Studio Code](https://code.visualstudio.com/)
31+
- the
32+
[DevContainers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
33+
- [Docker](https://www.docker.com) >= 27.0.0
34+
2835
### Variables
2936

3037
You can configure the API endpoint and/or map tiles using the following
@@ -48,6 +55,19 @@ You can create a copy of `.env.example`, rename it to `.env` and set the values.
4855
5. Run `npm run build`
4956
6. Run `npm run dev` to start the local server
5057

58+
#### Using a DevContainer
59+
60+
Simply open the project in Visual Studio Code. It should prompt and ask you if
61+
you would like to open the project in a DevContainer.
62+
63+
If you are not prompted hit <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>
64+
(<kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd> on Mac) and select
65+
`>DevContainers: Open Workspace in Container...`.
66+
67+
The DevContainer will now build (which will take a bit the first time your are
68+
doing this) and the window will reload. For convenience `npm install` and
69+
`npm run build` are executed for you on start.
70+
5171
### Debugging
5272

5373
For users of [Visual Studio Code](https://code.visualstudio.com/) there is a

0 commit comments

Comments
 (0)