Skip to content

Commit

Permalink
Merge branch 'main' into search-result-error
Browse files Browse the repository at this point in the history
  • Loading branch information
Snehal Kumbhar committed May 25, 2021
2 parents 46d52e2 + c25280d commit 5c7f175
Show file tree
Hide file tree
Showing 27 changed files with 840 additions and 445 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,20 @@
# Changelog

## [4.8.0](https://www.github.com/dasch-swiss/dsp-app/compare/v4.7.0...v4.8.0) (2021-05-21)


### Maintenance

* **CD/CI:** automatically detect common vulnerabilities and coding errors ([#438](https://www.github.com/dasch-swiss/dsp-app/issues/438)) ([af02332](https://www.github.com/dasch-swiss/dsp-app/commit/af023322f1fd03c2659c7127adcd856ac9e6f25d))
* **compiler:** enable strict template (DSP-1403) ([#432](https://www.github.com/dasch-swiss/dsp-app/issues/432)) ([583a338](https://www.github.com/dasch-swiss/dsp-app/commit/583a338d99fa8dca74c07182d0471219c382f9d1))
* **environment:** add test-server config (DSP-1650) ([#443](https://www.github.com/dasch-swiss/dsp-app/issues/443)) ([a56a45b](https://www.github.com/dasch-swiss/dsp-app/commit/a56a45ba84f3f62e7b5b1d32fc42954099827280))
* Replace favicon and term Knora by DSP (DSP-1181 / DSP-1342) ([#441](https://www.github.com/dasch-swiss/dsp-app/issues/441)) ([3b038b6](https://www.github.com/dasch-swiss/dsp-app/commit/3b038b688f8db9da86aa74c2811d93250541d860))


### Enhancements

* **ontology:** new method to change gui order (DSP-1567/DSP-1646) ([#440](https://www.github.com/dasch-swiss/dsp-app/issues/440)) ([dfd0ce0](https://www.github.com/dasch-swiss/dsp-app/commit/dfd0ce094fbfb047a16d86c59e4edc6f005281d2))

## [4.7.0](https://www.github.com/dasch-swiss/dsp-app/compare/v4.6.0...v4.7.0) (2021-05-07)


Expand Down
14 changes: 1 addition & 13 deletions README.md
Expand Up @@ -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.

Expand All @@ -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).
32 changes: 32 additions & 0 deletions angular.json
Expand Up @@ -71,6 +71,32 @@
"maximumWarning": "6kb"
}
]
},
"test-server": {
"fileReplacements": [
{
"replace": "src/environments/environment.ts",
"with": "src/environments/environment.test-server.ts"
}
],
"optimization": false,
"sourceMap": true,
"namedChunks": false,
"aot": true,
"extractLicenses": false,
"vendorChunk": false,
"buildOptimizer": false,
"budgets": [
{
"type": "initial",
"maximumWarning": "8mb",
"maximumError": "8mb"
},
{
"type": "anyComponentStyle",
"maximumWarning": "6kb"
}
]
}
}
},
Expand All @@ -82,6 +108,9 @@
"configurations": {
"production": {
"browserTarget": "dsp-app:build:production"
},
"test-server": {
"browserTarget": "dsp-app:build:test-server"
}
}
},
Expand Down Expand Up @@ -140,6 +169,9 @@
"configurations": {
"production": {
"devServerTarget": "dsp-app:serve:production"
},
"test-server": {
"devServerTarget": "dsp-app:serve:test-server"
}
}
},
Expand Down
15 changes: 11 additions & 4 deletions docs/how-to-contribute/index.md
Expand Up @@ -3,7 +3,14 @@
<!-- TODO: the following section is moved from the main README and has to be updated -->
## 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: <https://api.test.dasch.swiss/version>). 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

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 5c7f175

Please sign in to comment.