Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
QubitPi committed Aug 29, 2023
1 parent 5b7a679 commit 7a2df07
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
18 changes: 7 additions & 11 deletions docs/docs/elide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Running Webservice in Docker Compose

### Step 1: Defining Data Models

To inject [Elide model package](https://github.com/yahoo/elide/tree/master/elide-standalone#create-models), simply put
the models in a separate JAR and include it as a dependency in POM. If the model package is internal and cannot be
To inject [Elide model package](https://github.com/yahoo/elide/tree/master/elide-standalone#create-models), simply put
the models in a separate JAR and include it as a dependency in POM. If the model package is internal and cannot be
visible publicly, either make the webservice project private or public with env variable masking, for example:

```xml
Expand All @@ -41,7 +41,7 @@ visible publicly, either make the webservice project private or public with env
<version>${env.MODEL_PACKAGE_JAR_VERSION}</version>
</dependency>
</dependencies>

...

<repositories>
Expand All @@ -66,12 +66,12 @@ export MODEL_PACKAGE_REPO_URL=https://private.mvnrepository.com/artifact/com.com

Jersey WS Template can run in [Docker Compose] for the following purposes

1. Decoupling frontend and backend development
2. Easily integrating application backed by Jersey WS Template testing in CI/CD
1. Decoupling frontend and backend developments
2. Making it easy to run E2E testing of Jersey WS Template-backed application in CI/CD

:::caution

Docker Compose designed here is intended for local development and testing purposes ONLY! _It is strongly discouraged
Docker Compose designed here is intended for local development and testing purposes ONLY! _It is strongly discouraged
to run this Docker Compose in production!_

:::
Expand Down Expand Up @@ -103,7 +103,7 @@ The variable will be [passed](https://stackoverflow.com/a/58900415) into Docker

_If tests is running in IntelliJ IDE_, make sure the model package JAR it is in IDE's **External Libraries**

Otherwise, the dependency injection didn't find a bean class under the package specified by
Otherwise, the dependency injection didn't find a bean class under the package specified by
[JWT_MODEL_PACKAGE_NAME](#step-1-defining-data-models)

### Entity Missing Default Constructor
Expand Down Expand Up @@ -133,15 +133,11 @@ To optionally disable GraphQL endpoints, exclude corresponding dependencies in P
</dependency>
```

[BinderFactory]: https://github.com/QubitPi/jersey-ws-template/blob/jpa-elide/src/main/java/com/qubitpi/ws/jersey/template/application/BinderFactory.java

[Elide]: https://elide.io/
[Elide instance class]: https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/Elide.java
[Elide Standalone]: https://github.com/yahoo/elide/tree/master/elide-standalone
[ElideSettings instance class]: https://github.com/yahoo/elide/blob/master/elide-core/src/main/java/com/yahoo/elide/ElideSettings.java

[Jersey Webservice Template]: https://qubitpi.github.io/jersey-ws-template/

[ResourceConfig]: https://github.com/QubitPi/jersey-ws-template/blob/jpa-elide/src/main/java/com/qubitpi/ws/jersey/template/application/ResourceConfig.java

[what is binding]: https://qubitpi.github.io/jersey/ioc.html
6 changes: 3 additions & 3 deletions docs/docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 2
title: Setup
---

This section discusses the one-time setup in order to develop [Jersey Webservice Template]
This section discusses the one-time setup in order to develop [Jersey Webservice Template].

Prepare for Local Development
-----------------------------
Expand Down Expand Up @@ -66,7 +66,7 @@ Getting Source Code
-------------------

```bash
https://github.com/QubitPi/jersey-ws-template.git
git clone git@github.com:QubitPi/jersey-ws-template.git
cd jersey-ws-template
```

Expand All @@ -75,7 +75,7 @@ cd jersey-ws-template
For the moment, we have distilled the most important code style conventions with respect to jersey-ws-template's code as
IntelliJ settings. If IntelliJ is used for IDE, we may import these code style settings by importing the
[Jersey-WS-Template-Project-intellij-code-style.xml][style config] file in the root of the repo. The setting for the
project will appear as a new Scheme named Jersey-WS-Template-Project under IDE's `Editor -> Code Style` section.
project will appear as a new Scheme named "Jersey-WS-Template-Project" under IDE's `Editor -> Code Style` section.

Modifying Templates
-------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public void filter(
response.getHeaders().add("Access-Control-Allow-Credentials", "true");
response.getHeaders().add(
"Access-Control-Allow-Methods",
"GET, POST, PUT, DELETE, OPTIONS, HEAD"
"GET, POST, PUT, DELETE, OPTIONS, HEAD, PATCH"
);
}
}

0 comments on commit 7a2df07

Please sign in to comment.