diff --git a/README.md b/README.md index 7ffd559488..67d901e8b2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ 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. -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. +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. Additionaly it's built with [DSP-UI-LIB](https://www.npmjs.com/package/@dasch-swiss/dsp-ui) — reusable DSP specific Angular modules. @@ -32,18 +32,6 @@ DSP-APP is [free software](http://www.gnu.org/philosophy/free-sw.en.html), relea 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/). -### Work on GitHub - -DSP-APP has two main branches at the moment: - -#### "main" branch - -- 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. - -#### "develop" branch - -- 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. - ### Documentation / User guidelines 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). diff --git a/docs/how-to-contribute/index.md b/docs/how-to-contribute/index.md index d0e375baae..148a17e8de 100644 --- a/docs/how-to-contribute/index.md +++ b/docs/how-to-contribute/index.md @@ -3,7 +3,14 @@ ## Development server -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. +DSP-APP is built with [Angular](https://angular.io/) and uses [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). + +You have to install the corresponding packages with `npm i`. Now you have to possibilites to run the application in developer mode: + +- With a local installed [DSP-API environment](https://docs-api.dasch.swiss/04-publishing-deployment/getting-started/) run `ng serve` or `npm run start`. +- 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: ). With this solution you will also have access to all the representation files. + +In both case navigate to `http://0.0.0.0:4200/`. The app will automatically reload if you change any of the resource files. ## Code scaffolding @@ -34,9 +41,9 @@ Run `npm run lint-local` to execute the lint service via [ESLint](https://eslint To integrate ESLint with Visual Studio Code, do the following: -* Install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension. -* Create a task via the **Tasks: Configure Task** command and select `npm: lint-local`. -* In the resulting `tasks.json` file, configure the problem matcher to be `$eslint-stylish`. +- Install the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension. +- Create a task via the **Tasks: Configure Task** command and select `npm: lint-local`. +- In the resulting `tasks.json` file, configure the problem matcher to be `$eslint-stylish`. ## Further help