Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation about contribution (DSP-1657) #449

Merged
merged 5 commits into from May 25, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 0 additions & 12 deletions README.md
Expand Up @@ -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).
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