Skip to content

Commit

Permalink
branding updates
Browse files Browse the repository at this point in the history
  • Loading branch information
karissarjacobsen committed Jun 5, 2024
1 parent c271352 commit c898b4f
Show file tree
Hide file tree
Showing 19 changed files with 63 additions and 63 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2023 DocuSign, Inc. (https://www.docusign.com)
Copyright (c) 2024 Docusign, Inc. (https://www.docusign.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
44 changes: 22 additions & 22 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,27 @@
### Github repo: MyUniSampleApp

## Introduction
MyUni is a DocuSign sample application written in Python 3.7 (server) and React (client). You can find a live instance running at [https://myuni.sampleapps.docusign.com/](https://myuni.sampleapps.docusign.com/).
MyUni is a Docusign sample application written in Python 3.7 (server) and React (client). You can find a live instance running at [https://myuni.sampleapps.docusign.com/](https://myuni.sampleapps.docusign.com/).

MyUni demonstrates the following:

1. Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
2. **Change Your Major or Minor:** ([Source](./app/api/requests.py))
This example uses the DocuSign [eSignature REST API](https://developers.docusign.com/docs/esign-rest-api) to send an envelope based on an HTML template with prefilled user data and then initiate an embedded signing ceremony for a single signer. [AutoPlace](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) (anchor text) is used to position the signing fields in the documents.
3. **Request an Unofficial Transcript:** ([Source](./app/api/clickwrap.py))
This example demonstates the DocuSign [Click API](https://developers.docusign.com/docs/click-api/). Once the user submits the form, the app uses a clickwrap to present a modal dialog requesting confirmation before allowing the user to download an unofficial transcript.
[More information about ClickAPI](https://developers.docusign.com/docs/click-api)
4. **Sign Up for Extracurricular Activities:** ([Source](./app/api/requests.py))
This example uses the DocuSign [eSignature REST API](https://developers.docusign.com/docs/esign-rest-api), demonstrating how to use envelopes combined with payment gateways. The example sends an envelope based on HTML template and adds payment feature to the document, so after signing, the user will be able to pay for their chosen activity.
1. Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
2. **Change Your Major or Minor:** ([Source](./app/api/requests.py))
This example uses the Docusign [eSignature REST API](https://developers.docusign.com/docs/esign-rest-api) to send an envelope based on an HTML template with prefilled user data and then initiate an embedded signing ceremony for a single signer. [AutoPlace](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) (anchor text) is used to position the signing fields in the documents.
3. **Request an Unofficial Transcript:** ([Source](./app/api/clickwrap.py))
This example demonstates the Docusign [Click API](https://developers.docusign.com/docs/click-api/). Once the user submits the form, the app uses a clickwrap to present a modal dialog requesting confirmation before allowing the user to download an unofficial transcript.
[More information about ClickAPI](https://developers.docusign.com/docs/click-api)
4. **Sign Up for Extracurricular Activities:** ([Source](./app/api/requests.py))
This example uses the Docusign [eSignature REST API](https://developers.docusign.com/docs/esign-rest-api), demonstrating how to use envelopes combined with payment gateways. The example sends an envelope based on HTML template and adds payment feature to the document, so after signing, the user will be able to pay for their chosen activity.
To use this example, create a test payments gateway for your developer account.

## Installation

### Prerequisites

* A DocuSign developer account. Create a [free account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16535).
* A DocuSign integration key (a client ID) that is configured to use JSON Web Token (JWT) Grant.
You will need the **integration key** itself and its **RSA key pair**. To use this application, you must add your application's **Redirect URI** to your integration key. This [**video**](https://www.youtube.com/watch?v=GgDqa7-L0yo) demonstrates how to create an integration key (client ID) for a user application like this example.
* A Docusign developer account. Create a [free account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16535).
* A Docusign integration key (a client ID) that is configured to use JSON Web Token (JWT) Grant.
You will need the **integration key** itself and its **RSA key pair**. To use this application, you must add your application's **Redirect URI** to your integration key. This [**video**](https://www.youtube.com/watch?v=GgDqa7-L0yo) demonstrates how to create an integration key (client ID) for a user application like this example.
* [Python 3.7+](https://www.python.org/downloads/)
* [venv](https://docs.python.org/3/library/venv.html#module-venv)
* [Node.js](https://nodejs.org/) v10+
Expand All @@ -40,8 +40,8 @@ MyUni demonstrates the following:
* **DS_PRIVATE_KEY** - Private key string, source or path; for instance: /app/id_rsa
* **REACT_APP_DS_RETURN_URL** - URL where the back end of the application is located (If you run it locally, use `http://localhost:3000`)
* **REACT_APP_API_BASE_URL** - URL where the front end of the application is located; will be used by Docusign to redirect back after signing ceremony (If you run it locally, use `http://localhost:5001/api`)
* **DS_AUTH_SERVER** - The DocuSign authentication server (for testing purposes, use `https://account-d.docusign.com`)
* **REACT_APP_DS_DEMO_SERVER** - Link to the DocuSign demo server (for testing purposes, use `https://demo.docusign.net`)
* **DS_AUTH_SERVER** - The Docusign authentication server (for testing purposes, use `https://account-d.docusign.com`)
* **REACT_APP_DS_DEMO_SERVER** - Link to the Docusign demo server (for testing purposes, use `https://demo.docusign.net`)
* **REACT_APP_DS_CLICKWRAP_URL** - Link to the hosted clickwrap client (for testing purposes, use `//demo.docusign.net/clickapi/sdk/latest/docusign-click.js`)

### Installation steps
Expand All @@ -52,7 +52,7 @@ MyUni demonstrates the following:
2. Navigate to that folder: **`cd sample-app-myuni-python`** directory
3. Install python packages **`pip install -r requirements.txt`**
4. Install React dependencies using [npm](https://www.npmjs.com/) package manager **npm install**
5. Update the **.env** file with the integration key and other settings.
5. Update the **.env** file with the integration key and other settings.
> **Note:** Protect your integration key and client secret. You should make sure that your **.env** file will not be stored in your source code repository.
6. Navigate to [the admin demo Apps and Keys page](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys), add the Redirect URI http://localhost:3000/callback and then hit save

Expand All @@ -61,15 +61,15 @@ MyUni demonstrates the following:
1. Download or clone this repository to your workstation in the folder **sample-app-myuni-python**.
2. Navigate to the scripts subfolder: **`cd sample-app-myuni-python/scripts`**
3. Run the installation script: **`./install.sh`**
4. Update the **.env** file with the integration key and other settings.
4. Update the **.env** file with the integration key and other settings.
> **Note:** Protect your integration key and client secret. You should make sure that your **.env** file will not be stored in your source code repository.
5. Navigate to [the admin demo Apps and Keys page](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys), add the Redirect URI http://localhost:3000/callback and then hit save

### Additional installation scripts
All installation scripts are located in the **scripts** folder.
1. To stop the application, run **`./stop.sh`**
1. To remove the virtual environment and modules, run **`./clean.sh`**

## Running MyUni

### Manual
Expand All @@ -86,16 +86,16 @@ All installation scripts are located in the **scripts** folder.
2. Run the application script: **`./run.sh`**
3. Open a browser to **http://localhost:3000**

## Configuring a DocuSign payments gateway
## Configuring a Docusign payments gateway

DocuSign offers built-in connections to multiple payment gateways. The payments example in this sample app uses a demo account for the Stripe gateway service.
Docusign offers built-in connections to multiple payment gateways. The payments example in this sample app uses a demo account for the Stripe gateway service.

### Creating the payments gateway account

1. Log in to your [developer account](https://appdemo.docusign.com/) and select Admin.
2. On the Integrations/Payments screen, click Stripe.
3. For development, you can skip the Stripe account application by using the `Skip this account form` on the top of the page.
The Admin Panel will show that an enabled Stripe payment gateway account has been associated with your DocuSign developer account.
3. For development, you can skip the Stripe account application by using the `Skip this account form` on the top of the page.
The Admin Panel will show that an enabled Stripe payment gateway account has been associated with your Docusign developer account.
5. Configure the example launcher with the gateway account ID shown in the Admin panel.
6. Add the payment gateway account ID to the **.env** file.

Expand Down
2 changes: 1 addition & 1 deletion app/document.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def create(cls, tpl, student, envelope_args):
).decode('ascii')

# Create the document model
document = Document( # Create the DocuSign document object
document = Document( # Create the Docusign document object
document_base64=base64_file_content,
name='Change minor/major field',
file_extension='html',
Expand Down
4 changes: 2 additions & 2 deletions app/templates/minor-major.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DocuSign</title>
<title>Docusign</title>
<meta name="description" content="">
<meta name="keywords" content="">
<style>
Expand Down Expand Up @@ -158,7 +158,7 @@
<nav class="navbar">
<a class="navbar-brand" href="#">
<span class="navbar-brand-image d-inline-block">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="DocuSign logo">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="Docusign logo">
</span>
MyUni
</a>
Expand Down
4 changes: 2 additions & 2 deletions app/templates/multi-sign.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DocuSign</title>
<title>Docusign</title>
<meta name="description" content="">
<meta name="keywords" content="">
<style>
Expand Down Expand Up @@ -158,7 +158,7 @@
<nav class="navbar">
<a class="navbar-brand" href="#">
<span class="navbar-brand-image d-inline-block">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="DocuSign logo">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="Docusign logo">
</span>
MyUni
</a>
Expand Down
4 changes: 2 additions & 2 deletions app/templates/payment-activity.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DocuSign</title>
<title>Docusign</title>
<meta name="description" content="">
<meta name="keywords" content="">
<style>
Expand Down Expand Up @@ -163,7 +163,7 @@
<nav class="navbar">
<a class="navbar-brand" href="#">
<span class="navbar-brand-image d-inline-block">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="DocuSign logo">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="Docusign logo">
</span>
MyUni
</a>
Expand Down
4 changes: 2 additions & 2 deletions app/templates/transcript.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DocuSign</title>
<title>Docusign</title>
<meta name="description" content="">
<meta name="keywords" content="">
<style>
Expand Down Expand Up @@ -178,7 +178,7 @@
<nav class="navbar">
<a class="navbar-brand" href="#">
<span class="navbar-brand-image d-inline-block">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="DocuSign logo">
<img src="data:image/png;base64,{{ img_base64_src }}" alt="Docusign logo">
</span>
MyUni
</a>
Expand Down
Binary file removed public/favicon.ico
Binary file not shown.
Binary file added public/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
})(window,document,'script','dataLayer','GTM-WPK6FN5');</script>
<!-- End Google Tag Manager -->
<meta charset="utf-8" />
<link rel="icon" href="favicon.ico" />
<link rel="icon" href="favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<title>MyUni DocuSign Sample Application</title>
<meta name="description" content="See how the MyUni DocuSign sample application for education showcases the capabilities of the DocuSign API to enable you to integrate DocuSign functionality into your own applications.">
<title>MyUni Docusign Sample Application</title>
<meta name="description" content="See how the MyUni Docusign sample application for education showcases the capabilities of the Docusign API to enable you to integrate Docusign functionality into your own applications.">
<meta property="og:type" content="article" />
<meta name="twitter:title" content="MyUni DocuSign Sample Application" />
<meta name="twitter:description" content="See how the MyUni DocuSign sample application for education showcases the capabilities of the DocuSign API to enable you to integrate DocuSign functionality into your own applications." />
<meta property="og:title" content="MyUni DocuSign Sample Application" />
<meta property="og:description" content="See how the MyUni DocuSign sample application for education showcases the capabilities of the DocuSign API to enable you to integrate DocuSign functionality into your own applications." />
<meta name="twitter:title" content="MyUni Docusign Sample Application" />
<meta name="twitter:description" content="See how the MyUni Docusign sample application for education showcases the capabilities of the Docusign API to enable you to integrate Docusign functionality into your own applications." />
<meta property="og:title" content="MyUni Docusign Sample Application" />
<meta property="og:description" content="See how the MyUni Docusign sample application for education showcases the capabilities of the Docusign API to enable you to integrate Docusign functionality into your own applications." />
<meta property="og:image" content="%PUBLIC_URL%/MyUni_OG.png" />
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans:ital,wght@0,400;0,700;1,400;1,700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans:ital,wght@0,400;0,700;1,400;1,700&family=Noto+Serif&display=swap" rel="stylesheet">
Expand Down
12 changes: 6 additions & 6 deletions public/locales/en/About.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"Title": "MyUni Sample App",
"Description": "<p>This education-focused DocuSign sample application demonstrates some common DocuSign API integration workflows built from the DocuSign eSignature API, DocuSign Click API, DocuSign Payments, and DocuSign Connect.</p>",
"Description": "<p>This education-focused Docusign sample application demonstrates some common Docusign API integration workflows built from the Docusign eSignature API, Docusign Click API, Docusign Payments, and Docusign Connect.</p>",
"SourceButton": "GitHub Source",
"GitHubLink": " https://github.com/docusign/sample-app-myuni-python",
"SandboxText": "<h4>Get Started with the DocuSign APIs Today</h4>",
"SandboxText": "<h4>Get Started with the Docusign APIs Today</h4>",
"SandboxButton": "GET YOUR DEVELOPER ACCOUNT",
"Description2": "<p></br>With the DocuSign developer account, you can test our APIs for free! Developer accounts do not expire and have enterprise-level features enabled.</p>",
"Description2": "<p></br>With the Docusign developer account, you can test our APIs for free! Developer accounts do not expire and have enterprise-level features enabled.</p>",
"Features": "<h3>MyUni features:</h3><ul><li>Send document for signature</li><li>Update recipient information</li><li>Embedded signing </li><li>Create an envelope from HTML import</li><li>Real-time status reporting</li><li>Fill tab data</li><li>Create a clickwrap</li><li>Embed a clickwrap on your site</li><li>Calculated (formula) fields</li><liRequest payment</li></ul>",
"ToolsandLinks": "API Tools and Resources",
"DeveloperCenter": "Developer Center",
"DeveloperCenterLink": "https://developers.docusign.com",
"APICodeExamples": "DocuSign eSignature API Code Examples",
"APICodeExamples": "Docusign eSignature API Code Examples",
"APICodeExamplesLink": "https://developers.docusign.com/docs/esign-rest-api/how-to/",
"ESignatureDocumentation": "DocuSign eSignature API Reference",
"ESignatureDocumentation": "Docusign eSignature API Reference",
"ESignatureDocumentationLink": "https://developers.docusign.com/docs/esign-rest-api/reference/",
"DeveloperCommunity": "Developer Community",
"DeveloperCommunityLink": "http://stackoverflow.com/questions/tagged/docusignapi",
"AboutDocuSign": "<h3>About DocuSign</h3><ul><li>More than 1,000,000 paying customers and over a billion users in over 180 countries</li><li>More than 300,000 new unique users join the DocuSign Global Trust Network every day</li><li>83% of DocuSign documents are returned within 1 hour, with 50% completed within 15 minutes</li><li>$36 per document savings when you leave paper behind</li> <li>DocuSign is available in 44 languages</li></ul>"
"AboutDocuSign": "<h3>About Docusign</h3><ul><li>More than 1,000,000 paying customers and over a billion users in over 180 countries</li><li>More than 300,000 new unique users join the Docusign Global Trust Network every day</li><li>83% of Docusign documents are returned within 1 hour, with 50% completed within 15 minutes</li><li>$36 per document savings when you leave paper behind</li> <li>Docusign is available in 44 languages</li></ul>"
}
2 changes: 1 addition & 1 deletion public/locales/en/Common.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"TransactionHistoryLink": "Status",
"GitHubLink": "GitHub Source",
"AboutLink": "About",
"Copyright": "© 2023 DocuSign Inc.",
"Copyright": "© 2024 Docusign Inc.",
"LogOutLink": "Log out",
"LogInButton": "Log in",
"AlertMessage": "Sorry, there was some issue with the Code Grant Authorization, so you have been logged with JWT authorization"
Expand Down
Loading

0 comments on commit c898b4f

Please sign in to comment.