|
1 | | -# Getting Started with Create React App |
| 1 | +# ACCESS Q&A Tool Widget |
2 | 2 |
|
3 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 3 | +This REACT app provides an interface to the ACCESS Q&A Tool API. More information about this tool is available at https://support.access-ci.org/tools/access-qa-tool. |
| 4 | + |
| 5 | +Interacting with the Q&A Tool requires authentication with an ACCESS ID. Currently, the app checks for the class "user-logged-in" on the <body> HTML element to determine if a visitor is authenticated. |
| 6 | + |
| 7 | +The Q&A Tool API requires an API Key to be sent in the HTTP Headers. This should be set with the `REACT_APP_API_KEY` environment variable. Please contact ACCESS Support if you need an API Key. |
| 8 | + |
| 9 | +Some messages in the app can be customized if desired: |
| 10 | +- welcome message |
| 11 | +- prompt |
| 12 | + |
| 13 | +See the index.html file for examples of how to add the default widget floating in the bottom right of the page and as an "embedded" widget with the tool open on the page by default. |
4 | 14 |
|
5 | 15 | ## Available Scripts |
6 | 16 |
|
@@ -28,43 +38,3 @@ The build is minified and the filenames include the hashes.\ |
28 | 38 | Your app is ready to be deployed! |
29 | 39 |
|
30 | 40 | See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
31 | | - |
32 | | -### `npm run eject` |
33 | | - |
34 | | -**Note: this is a one-way operation. Once you `eject`, you can't go back!** |
35 | | - |
36 | | -If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
37 | | - |
38 | | -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. |
39 | | - |
40 | | -You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. |
41 | | - |
42 | | -## Learn More |
43 | | - |
44 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
45 | | - |
46 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
47 | | - |
48 | | -### Code Splitting |
49 | | - |
50 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) |
51 | | - |
52 | | -### Analyzing the Bundle Size |
53 | | - |
54 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) |
55 | | - |
56 | | -### Making a Progressive Web App |
57 | | - |
58 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) |
59 | | - |
60 | | -### Advanced Configuration |
61 | | - |
62 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) |
63 | | - |
64 | | -### Deployment |
65 | | - |
66 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) |
67 | | - |
68 | | -### `npm run build` fails to minify |
69 | | - |
70 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
0 commit comments