├── .gitignore
├── LICENSE
├── README.md
├── images
└── okta-app-settings.png
├── package-lock.json
├── package.json
├── src
├── client
│ ├── App.tsx
│ ├── MessageList.scss
│ ├── MessageList.tsx
│ ├── NewMessage.tsx
│ ├── auth.ts
│ ├── index.html
│ ├── index.tsx
│ └── tsconfig.json
├── global.d.ts
├── index.ts
└── socket.ts
├── tsconfig.json
└── tslint.json
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | .env
3 | dist
4 | .cache
5 | .idea/
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2019 Okta, Inc.
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Example App Using Node, TypeScript, and React
2 |
3 | This example app shows how to create a simple real-time chat server using Node and TypeScript, as well as a frontend to interact with it using React. This uses Okta for authentication.
4 |
5 | Please read [Build a Node.js API with TypeScript](https://developer.okta.com/blog/2019/05/07/nodejs-typescript-api) to see how this example was built.
6 |
7 | **Prerequisites**: [Node.js](https://nodejs.org/en/).
8 |
9 | ## Getting Started
10 |
11 | To install this example application, run the following commands:
12 |
13 | ```bash
14 | git clone https://github.com/oktadeveloper/okta-node-express-typescript-react-example.git
15 | cd okta-node-express-typescript-react-example
16 | npm install
17 | ```
18 |
19 | This will install a local copy of the project. You will need to set up some environment variables before the app will run properly.
20 |
21 | To integrate Okta's Identity Platform for user authentication, you'll first need to:
22 |
23 | * [Sign up for a free Okta Developer account](https://www.okta.com/developer/signup/)
24 | * You will get a URL similar to `https://dev-123456.oktapreview.com`.
25 | * Save this URL for later
26 | * You will also use this URL to login to your Okta account
27 |
28 | You will need to create an application in Okta:
29 |
30 | * Log in to your Okta account, then navigate to **Applications** and click the **Add Application** button
31 | * Select **Single-Page App** and click **Next**
32 | * Give your application a name (e.g. "Real-Time Chat")
33 | * Click **Done**
34 | * Save your **Client ID** for later
35 |
36 | Your Okta application should have settings similar to the following:
37 |
38 | 
39 |
40 | You'll also need to create a token in Okta:
41 |
42 | * From your Okta account, navigate to **Tokens** from the **API** dropwon in the header
43 | * Click **Create Token**
44 | * Give your token a name (e.g. "Real-Time Chat")
45 | * Click **Done**
46 | * Save your **Token** for later (if you lose this, you'll need to create another one)
47 |
48 | Now create a file called `.env` in the project root and add the following variables, replacing the values with your own from the previous steps.
49 |
50 | **.env**
51 | ```bash
52 | OKTA_ORG_URL=https://{yourOktaOrgUrl}
53 | OKTA_CLIENT_ID={yourClientId}
54 | OKTA_TOKEN={yourToken}
55 | ```
56 |
57 | Now you can run both the Node backend and the React frontend with the following command:
58 |
59 | ```bash
60 | npm start
61 | ```
62 |
63 | ## Links
64 |
65 | This example uses the [Okta JWT Verifier](https://github.com/okta/okta-oidc-js/tree/master/packages/jwt-verifier), the [Okta Node SDK](https://github.com/okta/okta-sdk-nodejs), and the [Okta React SDK](https://github.com/okta/okta-oidc-js/tree/master/packages/okta-react).
66 |
67 | ## Help
68 |
69 | Please [raise an issue](https://github.com/oktadeveloper/okta-node-express-typescript-react-example/issues) if you find a problem with the example application, or visit our [Okta Developer Forums](https://devforum.okta.com/). You can also email [developers@okta.com](mailto:developers@okta.com) if would like to create a support ticket.
70 |
71 | ## License
72 |
73 | Apache 2.0, see [LICENSE](LICENSE).
74 |
75 |
--------------------------------------------------------------------------------
/images/okta-app-settings.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oktadev/okta-node-express-typescript-react-example/c776d26fa7a46fc6124b757380c36610b0e0f52f/images/okta-app-settings.png
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "real-time-chat",
3 | "version": "1.0.0",
4 | "description": "",
5 | "main": "dist/index.js",
6 | "scripts": {
7 | "prebuild": "tslint -c tslint.json -p tsconfig.json --fix",
8 | "build": "tsc",
9 | "prestart": "npm run build",
10 | "start": "node .",
11 | "dev": "ts-node-dev src/index.ts",
12 | "test": "echo \"Error: no test specified\" && exit 1"
13 | },
14 | "keywords": [],
15 | "author": "",
16 | "license": "Apache-2.0",
17 | "dependencies": {
18 | "@okta/jwt-verifier": "^1.0.0",
19 | "@okta/okta-react": "^3.0.1",
20 | "@okta/okta-sdk-nodejs": "^3.3.1",
21 | "dotenv": "^8.2.0",
22 | "express": "^4.17.1",
23 | "immutable": "^4.0.0-rc.12",
24 | "react": "^16.13.1",
25 | "react-dom": "^16.13.1",
26 | "react-router": "^5.2.0",
27 | "react-router-dom": "^5.2.0",
28 | "socket.io": "^2.5.0",
29 | "socket.io-client": "^2.3.0",
30 | "uuid": "^8.1.0"
31 | },
32 | "devDependencies": {
33 | "@babel/core": "^7.10.2",
34 | "@babel/preset-env": "^7.10.2",
35 | "@types/dotenv": "^8.2.0",
36 | "@types/express": "^4.17.6",
37 | "@types/node": "^14.0.5",
38 | "@types/parcel-bundler": "^1.12.1",
39 | "@types/react": "^16.9.35",
40 | "@types/socket.io": "^2.1.8",
41 | "@types/uuid": "^8.0.0",
42 | "parcel-bundler": "^1.12.4",
43 | "sass": "^1.26.7",
44 | "ts-node-dev": "^1.0.0-pre.44",
45 | "tslint": "^6.1.2",
46 | "typescript": "^3.9.3"
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/src/client/App.tsx:
--------------------------------------------------------------------------------
1 | import React, { useEffect, useState } from "react";
2 | import io from "socket.io-client";
3 | import { useOktaAuth } from '@okta/okta-react';
4 | import { useAuth } from "./auth";
5 | import MessageList from "./MessageList";
6 | import NewMessage from "./NewMessage";
7 |
8 | export default () => {
9 | const { authService } = useOktaAuth();
10 | const [user, token] = useAuth();
11 | const [socket, setSocket] = useState(null);
12 |
13 | useEffect(() => {
14 | const newSocket = io(location.origin, token && { query: { token } });
15 | setSocket(newSocket);
16 | return () => newSocket.close();
17 | }, [token]);
18 |
19 | return socket && (
20 |