Skip to content

Commit f0a0109

Browse files
authored
Merge pull request #3 from docusign/DEVDOCS-14961
naming changes
2 parents f24315f + 9d0928e commit f0a0109

File tree

16 files changed

+63
-40
lines changed

16 files changed

+63
-40
lines changed

.env.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ NODE_ENV=development # Set to "production" so server serves static assets
44

55
### Client Variables
66
FRONTEND_DEV_HOST=http://localhost:3000
7-
FRONTEND_PROD_HOST=https://mymaestro.azurewebsites.net
7+
FRONTEND_PROD_HOST={PROD_HOST}
88

99
### Server Variables
1010
BACKEND_DEV_HOST=http://localhost:4000/api
11-
BACKEND_PROD_HOST=https://mymaestro.azurewebsites.net/api
11+
BACKEND_PROD_HOST={PROD_HOST}/api
1212
JWT_REDIRECT_URI=https://developers.docusign.com/platform/auth/consent # Where the user will be redirected after providing consent for JWT.
1313
DS_OAUTH_SERVER=https://account-d.docusign.com # The Docusign authentication server, used for JWT.
1414
USER_ID={YOUR_USER_ID} # A GUID unique to each user's Docusign Account, located on the Apps and Keys page.

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Node.js and React: MyMaestro Sample App
1+
# Node.js and React: Maestro Sample App
22

33
## Introduction
44

5-
Welcome to the MyMaestro sample app! MyMaestro is written using Node.js and React. Docusign Maestro lets you easily build and deploy customized workflows that automate and accelerate your agreement processes without writing any code. Maestro connects all the tools and activities in your workflow so that agreement processes are more efficient, more uniform, and have better visibility.
5+
Welcome to the Maestro Sample App! The app is written using Node.js and React. Docusign Maestro lets you easily build and deploy customized workflows that automate and accelerate your agreement processes without writing any code. Maestro connects all the tools and activities in your workflow so that agreement processes are more efficient, more uniform, and have better visibility.
66

77
With Docusign Maestro, you can combine Docusign features such as ID Verification, Web Forms, and eSignature with third-party extensions to automate your workflows from end to end.
88

@@ -20,7 +20,6 @@ Before you can run this sample app on your local machine, you must first create
2020
- Save the **integration key** and **private RSA key pair** somewhere safe as you will need these later.
2121
5. Add redirect URIs for your app. There are several variables from the **.env** file that are used in the code and configured for redirect urls. Find variables below in the **.env** file and add the values of these variables in the Docusign account settings in the appropriate **Redirect URIs** section:
2222
- FRONTEND_DEV_HOST (http://localhost:3000)
23-
- FRONTEND_PROD_HOST (https://mymaestro.azurewebsites.net)
2423
- JWT_REDIRECT_URI (https://developers.docusign.com/platform/auth/consent)
2524

2625
If you run this project in Docker using the **docker-compose.local.yml** file, the variable FRONTEND_DEV_HOST there changes to the value **http://localhost:80**. Keep in mind that in this case this value will also have to be added to the **Redirect URIs** section.
@@ -35,8 +34,8 @@ If you run this project in Docker using the **docker-compose.local.yml** file, t
3534

3635
### Install dependencies locally
3736

38-
1. Download or clone this repository to your workstation in a new folder named **sample-app-mymaestro-node**.
39-
2. Navigate to that folder: **`cd sample-app-mymaestro-node`**
37+
1. Download or clone this repository to your workstation in a new folder named **sample-app-maestro-node**.
38+
2. Navigate to that folder: **`cd sample-app-maestro-node`**
4039
3. Navigate to the **client** folder: **`cd client`**
4140
4. Install dependencies using the [npm](https://www.npmjs.com/) package manager: **`npm install`**
4241
5. Navigate to the **server** folder: **`cd ../server`**
@@ -45,20 +44,20 @@ If you run this project in Docker using the **docker-compose.local.yml** file, t
4544
> **Note:** Protect your integration key and client secret. You should make sure that the **.env** file will not be stored in your source code repository.
4645
8. Rename the **example_private.key** file to **private.key**, and paste your complete private RSA key into this file (including the header and footer of the key). This should be the private RSA you should have gotten when you created your Docusign account.
4746

48-
## Running MyMaestro in development mode
47+
## Running the Maestro Sample App in development mode
4948

50-
1. Navigate to the application folder: **`cd sample-app-mymaestro-node`**
49+
1. Navigate to the application folder: **`cd sample-app-maestro-node`**
5150
2. To start the server and client at the same time: **`npm run concurrently:dev`**
5251
3. **Or,** to run the server and client separately:
5352
- In one terminal, run **`npm run client:dev`**
5453
- In a separate terminal, run **`npm run server:dev`**
5554
4. Open a browser to **http://localhost:3000**
5655

57-
## Running MyMaestro in Docker
56+
## Running the Maestro Sample App in Docker
5857

5958
You can run the application in Docker locally in production mode:
6059

61-
1. Navigate to the application folder: **`cd sample-app-mymaestro-node`**
60+
1. Navigate to the application folder: **`cd sample-app-maestro-node`**
6261
2. Make sure that you configured **.env** file and saved your **private.key** in the root of the folder. Make sure that you have Docker installed.
6362
3. Run **`docker-compose -f docker-compose.local.yaml up -d`**
6463
4. To stop containers, run **`docker compose -f docker-compose.local.yaml down`**

client/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# MyMaestro Frontend
1+
# Maestro Sample App Frontend
22

33
![React + Vite](./src/assets/img/favicon.png) ![React + Vite](./src/assets/img/logo.svg)
44

55
Created with React + Vite! This setup provides a minimal yet powerful environment to develop React applications with Vite. It includes Hot Module Replacement (HMR) and some ESLint rules to ensure code quality.
66

77
## Table of Contents
88

9-
- [MyMaestro Frontend](#mymaestro-frontend)
9+
- [Maestro Sample App Frontend](#maestro-frontend)
1010
- [Table of Contents](#table-of-contents)
1111
- [Available Scripts](#available-scripts)
1212
- [`npm run dev`](#npm-run-dev)

client/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
<head>
44
<meta charset="UTF-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<meta property="og:title" content="MyMaestro Sample App" />
7-
<meta property="og:description" content="Leverage the power of Docusign workflows with Maestro. MyMaestro showcases how the Maestro API (beta) can be used to create workflow definitions and trigger, cancel, and get status updates for workflow instances." />
6+
<meta property="og:title" content="Maestro Sample App" />
7+
<meta property="og:description" content="Leverage the power of Docusign workflows with Maestro. The Maestro Sample App showcases how the Maestro API (beta) can be used to create workflow definitions and trigger, cancel, and get status updates for workflow instances." />
88
<meta property="og:image" content="/og-image.jpg" />
9-
<title>MyMaestro</title>
9+
<title>Maestro Sample App</title>
1010
<link rel="icon" type="image/x-icon" href="./src/assets/img/favicon.png">
1111
</head>
1212
<body>

0 commit comments

Comments
 (0)