Skip to content

Commit 87cfa8b

Browse files
meihDSmeihDS
authored
Updated README
Moved IntelliJ instructions to main README page. Deleted repeated Configure step. Deleted another "ceremony".
1 parent 17106fb commit 87cfa8b

1 file changed

Lines changed: 60 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 60 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This repo is a Java Spring Boot application that demonstrates:
3535
[Source.](./src/main/java/com/docusign/controller/eSignature/examples/EG011ControllerEmbeddedSending.java)
3636
1. **Embedded DocuSign web tool (NDSE).**
3737
[Source.](./src/main/java/com/docusign/controller/eSignature/examples/EG012ControllerEmbeddedConsole.java)
38-
1. **Embedded Signing Ceremony from a template with an added document.**
38+
1. **Embedded Signing from a template with an added document.**
3939
[Source.](./src/main/java/com/docusign/controller/eSignature/examples/EG013ControllerAddDocToTemplate.java)
4040
This example sends an envelope based on a template.
4141
In addition to the template's document(s), the example adds an
@@ -166,7 +166,65 @@ Run:
166166
$ cd target
167167
$ java -Dspring.profiles.active=dev -jar code-examples-java-1.0-SNAPSHOT.war
168168
```
169-
### Eclipse instructions
169+
170+
171+
## IntelliJ Ultimate instructions
172+
173+
The [IntelliJ IDE Ultimate edition](https://www.jetbrains.com/idea/)
174+
can be used with the example. The IntelliJ Ultimate edition is
175+
required due to its support for Spring Boot and JSP view pages.
176+
177+
**Step 1.** Download or clone the
178+
[code-examples-java](https://github.com/docusign/code-examples-java)
179+
repository
180+
181+
**Step 2.** Start IntelliJ Ultimate and choose the **Import Project** option.
182+
183+
![IntelliJ Import project](https://github.com/docusign/code-examples-java/blob/master/docs/install_fig_1.png)
184+
185+
**Step 3.** Use the popup file chooser to select the
186+
**code-examples-java** directory.
187+
188+
**Step 4.** The **Import Project** wizard will open. It's a
189+
series of screens. On the first screen, select
190+
**Import project from external model** and **Maven**.
191+
192+
![IntelliJ Import Maven project](https://github.com/docusign/code-examples-java/blob/master/docs/install_fig_2.png)
193+
194+
**Step 5.** Click **Finish** and the project will
195+
be displayed in the IDE.
196+
197+
### Configuring the IDE's *Run/Debug Configuration*
198+
IntelliJ uses **Run/Debug Configurations** to manage
199+
settings for running the example.
200+
201+
**One time:** setup a Run/Debug Configuration for the example:
202+
203+
Step 1. Use the menu command **Run / Edit configurations...**
204+
to open the configuration manager.
205+
206+
Step 2. Click the **+** (plus) sign to add a new configuration.
207+
The configuration type is **Spring Boot**. You may need to
208+
open the additional templates section of the template chooser.
209+
210+
Step 3. Update the form with the **Name** of the
211+
configuration and the **Main class** for the configuration,
212+
`com.docusign.App` **Tip:** use the **...** (ellipses) button next to the field to choose the Main class.
213+
214+
Tip: check the **Enable debug output** checkbox.
215+
216+
![Configure a Run configuration](https://github.com/docusign/code-examples-java/blob/master/docs/install_fig_7.png)
217+
218+
### Running or debugging the example
219+
220+
Use a **Run** menu option to run or debug the example.
221+
222+
After the application is ready for requests, open your
223+
browser to http://localhost:8080
224+
225+
226+
227+
## Eclipse instructions
170228
* Download or clone this repository.
171229
* Open Eclipse and select import. When the window appears, click the Maven folder, then click `Existing Maven Project` and choose `Next`.
172230
* For the Root directory, Browse for and select this same repo `code-examples-java`.
@@ -180,23 +238,6 @@ $ java -Dspring.profiles.active=dev -jar code-examples-java-1.0-SNAPSHOT.war
180238
* Open a browser and navigate to http://localhost:8080 to see the examples running.
181239

182240

183-
### IntelliJ Ultimate installation
184-
185-
See the [IntelliJ Ultimate instructions](https://github.com/docusign/code-examples-java/blob/master/docs/Readme_IntelliJ_Ultimate.md).
186-
187-
## Configure the example
188-
189-
Configure the example via the properties file:
190-
`code-examples-java/src/main/resources/application-dev.properties`.
191-
192-
Add the client id, secret, signer name and email to the file.
193-
Also add the URL that the application will use (the **DS_APP_URL** setting).
194-
By default, this is http://localhost:8080
195-
196-
You must also add a **Redirect URI** to the client id's settings in
197-
DocuSign. The Redirect URIs are `/login&type=acg` and `/login&type=jwt` appended to the DS_APP_URL setting.
198-
Eg http://localhost:8080/login&type=acg
199-
200241
### Payments code example
201242
To use the payments example, create a
202243
test payments gateway for your developer sandbox account.

0 commit comments

Comments
 (0)