Skip to content

Commit c25280d

Browse files
authored
docs: update documentation about contribution (DSP-1657) (#449)
* docs: update main README * docs: update main README * docs: fix dead link
1 parent 3f0d6d9 commit c25280d

2 files changed

Lines changed: 12 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
99
This app is a simple user interface for the Data and Service Center for the Humanities DaSCH, which uses the DSP-API server application in the backend. It's a system for annotation and linkage of resources in arts and humanities.
1010

11-
DSP-APP implements [DSP-JS-LIB](https://www.npmjs.com/package/@dasch-swiss/dsp-js) to connect with [DSP-API](https://docs.dasch.swiss/developers/knora/api-reference/). DSP (DaSCH Service Platform) is a software framework for storing, sharing, and working with primary resources and data in the humanities.
11+
DSP-APP implements [DSP-JS-LIB](https://www.npmjs.com/package/@dasch-swiss/dsp-js) to connect with [DSP-API](https://docs-api.dasch.swiss/03-apis/). DSP (DaSCH Service Platform) is a software framework for storing, sharing, and working with primary resources and data in the humanities.
1212

1313
Additionaly it's built with [DSP-UI-LIB](https://www.npmjs.com/package/@dasch-swiss/dsp-ui) — reusable DSP specific Angular modules.
1414

@@ -32,18 +32,6 @@ DSP-APP is [free software](http://www.gnu.org/philosophy/free-sw.en.html), relea
3232

3333
If you would like to contribute to the development of the DSP-APP alongside us, please consult the [general DSP contribution guidelines](https://docs.dasch.swiss/developers/dsp/contribution/).
3434

35-
### Work on GitHub
36-
37-
DSP-APP has two main branches at the moment:
38-
39-
#### "main" branch
40-
41-
- use the branch "main" to work on the DSP-ADMIN app. Any changes should be created in branches from "main" and should be merged into the "main" branch.
42-
43-
#### "develop" branch
44-
45-
- use the branch "develop" to work on the whole DSP-APP app (admin + research parts). Any new developments should be created in branches from "develop" and should be merged into the "develop" branch.
46-
4735
### Documentation / User guidelines
4836

4937
We built the user guidelines and developer documentation with [MkDocs](https://www.mkdocs.org/). Get more information in the appropriate [README](https://github.com/dasch-swiss/dsp-app/blob/main/docs/README.md).

‎docs/how-to-contribute/index.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@
33
<!-- TODO: the following section is moved from the main README and has to be updated -->
44
## Development server
55

6-
Run `ng serve` or `npm run start` for a dev server. Navigate to `http://0.0.0.0:4200/`. The app will automatically reload if you change any of the resource files.
6+
DSP-APP is built with [Angular](https://angular.io/) and uses [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
7+
8+
You have to install the corresponding packages with `npm i`. Now you have to possibilites to run the application in developer mode:
9+
10+
- With a local installed [DSP-API environment](https://docs-api.dasch.swiss/04-publishing-deployment/getting-started/) run `ng serve` or `npm run start`.
11+
- If you want to connect to the DSP-API on our test server run `ng serve --configuration=test-server` or `npm run start-with-test-server`. Please consider which version of DSP-API is currently running on the test server (see webapi: <https://api.test.dasch.swiss/version>). With this solution you will also have access to all the representation files.
12+
13+
In both case navigate to `http://0.0.0.0:4200/`. The app will automatically reload if you change any of the resource files.
714

815
## Code scaffolding
916

@@ -34,9 +41,9 @@ Run `npm run lint-local` to execute the lint service via [ESLint](https://eslint
3441

3542
To integrate ESLint with Visual Studio Code, do the following:
3643

37-
* Install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.
38-
* Create a task via the **Tasks: Configure Task** command and select `npm: lint-local`.
39-
* In the resulting `tasks.json` file, configure the problem matcher to be `$eslint-stylish`.
44+
- Install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension.
45+
- Create a task via the **Tasks: Configure Task** command and select `npm: lint-local`.
46+
- In the resulting `tasks.json` file, configure the problem matcher to be `$eslint-stylish`.
4047

4148
## Further help
4249

0 commit comments

Comments
 (0)