Skip to content

Commit

Permalink
Merge pull request #993 from pascalgrimaud/readme-improve-contributin…
Browse files Browse the repository at this point in the history
…g-with-front

README: improve contributing with front
  • Loading branch information
pascalgrimaud authored Mar 11, 2022
2 parents 1ad0a9f + c649f1b commit 32f103b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
21 changes: 16 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ javac 17.0.1

#### Node.js and NPM

[Node.js](https://nodejs.org/): we use Node to run a prettier as code formatter.
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
[Node.js](https://nodejs.org/): we use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

```
$ node -v
Expand All @@ -78,7 +77,7 @@ $ npm -v

#### Docker and Docker-compose

To add containers for development (like Databases, Sonar...) you need:
To launch containers for development (like Databases, Sonar...) you need:

- [Docker](https://docs.docker.com/engine/install/) _(minimum version: 20.xx.xx)_
- [Docker Compose](https://docs.docker.com/compose/install/) _(minimum version: 1.29.x)_
Expand Down Expand Up @@ -135,7 +134,7 @@ upstream git@github.com:jhipster/jhipster-lite.git (fetch)
upstream git@github.com:jhipster/jhipster-lite.git (push)
```

You can edit you `.git/config`, and update this section:
You can edit your `.git/config`, and update this section:

```
[remote "upstream"]
Expand All @@ -160,10 +159,22 @@ For testing:
./mvnw clean verify
```

For testing the front only:

```
npm run test
```

For running the project:

```
./mvnw spring-boot:run
./mvnw
```

For running the front only:

```
npm run start
```

### Use a text editor
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,20 @@ java -jar target/*.jar

Then navigate to http://localhost:7471/swagger-ui.html in your browser.

## e2e tests

You need to run the project first. Then, you can run the end-to-end tests:

```
npm run e2e
```

Or in headless mode:

```
npm run e2e:headless
```

## Generate your project

Go to http://localhost:7471/swagger-ui.html and build your own JSON to generate a project. Here an example:
Expand Down

0 comments on commit 32f103b

Please sign in to comment.