Skip to content

Commit 1cddaba

Browse files
committed
Readme
1 parent ca5be16 commit 1cddaba

File tree

2 files changed

+162
-23
lines changed

2 files changed

+162
-23
lines changed

README.md

Lines changed: 61 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# ArcGIS JS API 4.4 / React / Redux Boilerplate
22

33
Web Scene viewer boilerplate web application using React and Redux, including the ArcGIS JS API
4-
as middleware. This boilerplate example integrates:
4+
as middleware. The example application displays a web scene with a simple sun position slider.
5+
6+
![Cover image](/img/screenshot1.jpg?raw=true "Cover image")
7+
8+
## Features
9+
10+
This boilerplate example integrates:
511

612
* [ArcGIS JS API 4.4](https://developers.arcgis.com/javascript/)
713
* [React](https://facebook.github.io/react/)
@@ -16,11 +22,20 @@ It provides two useful Redux
1622
* **arcgis-authentication** to handle Portal login
1723
* **arcgis-sceneview** to show a SceneView with a WebScene, handle selection, and environment changes.
1824

19-
The example application displays a web scene with a simple sun position slider.
25+
It provides support for:
2026

21-
![Cover image](/img/screenshot1.jpg?raw=true "Cover image")
27+
* [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension) - You can browse
28+
the state and dispatch actions live while the application is running.
29+
* [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/) - Updated
30+
**components** or **reducers** are automatically replaced while the application is running.
31+
The state is preserved during updates, and the web scene does not need to be reloaded.
32+
* Tests with [Jest](http://facebook.github.io/jest/) and [Enzyme](http://airbnb.io/enzyme/index.html)
33+
34+
![Redux Dev Tools](/img/screenshot2.jpg?raw=true "Redux Dev Tools")
35+
36+
![Hot Module Replacement](/img/screenshot3.jpg?raw=true "Hot Module Replacement")
2237

23-
# Instructions
38+
## Instructions
2439

2540
### Installing
2641

@@ -68,37 +83,60 @@ Build and run live server:
6883
$ npm run server
6984
```
7085

71-
# Redux Dev Tools
86+
## Requirements
87+
88+
* Notepad or your favorite HTML editor
89+
* Web browser with access to the Internet
90+
91+
## Resources
92+
93+
* [ArcGIS for JavaScript API Resource Center](http://help.arcgis.com/en/webapi/javascript/arcgis/index.html)
94+
* [Writing Tests - Redux](http://redux.js.org/docs/recipes/WritingTests.html)
95+
* [Jest Tests](http://facebook.github.io/jest/)
96+
* [Enzyme Tests](http://airbnb.io/enzyme/index.html)
97+
* [ArcGIS Blog](http://blogs.esri.com/esri/arcgis/)
98+
* [twitter@esri](http://twitter.com/esri)
99+
100+
## Issues
101+
102+
Find a bug or want to request a new feature? Please let us know by submitting an issue.
103+
104+
## Contributing
105+
106+
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).
107+
108+
## Licensing
109+
Copyright 2017 Esri
110+
111+
Licensed under the Apache License, Version 2.0 (the "License");
112+
you may not use this file except in compliance with the License.
113+
You may obtain a copy of the License at
114+
115+
http://www.apache.org/licenses/LICENSE-2.0
116+
117+
Unless required by applicable law or agreed to in writing, software
118+
distributed under the License is distributed on an "AS IS" BASIS,
119+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
120+
See the License for the specific language governing permissions and
121+
limitations under the License.
122+
123+
A copy of the license is available in the repository's [license.txt]( https://raw.github.com/Esri/quickstart-map-js/master/license.txt) file.
124+
125+
[](Esri Tags: ArcGIS Web Mapping QuickStart)
126+
[](Esri Language: JavaScript)​
72127

73-
This package supports the [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension)
74-
for Chrome. You can browse the state and dispatch actions live while the application is running.
75128

76-
![Redux Dev Tools](/img/screenshot2.jpg?raw=true "Redux Dev Tools")
77129

78-
# Hot Module Replacement
79130

80-
This example supports [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/).
81-
Updated **components** or **reducers** are automatically replaced while the application is running.
82-
The state is preserved during updates, and the web scene does not need to be reloaded.
83131

84-
![Hot Module Replacement](/img/screenshot3.jpg?raw=true "Hot Module Replacement")
85132

86-
# Tests
87133

88-
This example includes [Jest](http://facebook.github.io/jest/) tests for:
89134

90-
* Action creators
91-
* Reducers
92-
* ArcGIS Middleware
93135

94-
And [Enzyme](http://airbnb.io/enzyme/index.html) tests for:
95136

96-
* Components
97137

98-
For more details on testing see
99-
[Writing Tests - Redux](http://redux.js.org/docs/recipes/WritingTests.html).
100138

101-
# Build Process
139+
### Build Process
102140

103141
The [ArcGIS JS API](https://developers.arcgis.com/javascript/) is based on
104142
[Dojo](https://dojotoolkit.org/). To make this ES6 application work, we use

license.txt

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
Apache License - 2.0
2+
3+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
4+
5+
1. Definitions.
6+
7+
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
8+
9+
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
10+
11+
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control
12+
with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management
13+
of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial
14+
ownership of such entity.
15+
16+
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
17+
18+
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source,
19+
and configuration files.
20+
21+
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to
22+
compiled object code, generated documentation, and conversions to other media types.
23+
24+
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice
25+
that is included in or attached to the work (an example is provided in the Appendix below).
26+
27+
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the
28+
editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes
29+
of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of,
30+
the Work and Derivative Works thereof.
31+
32+
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work
33+
or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual
34+
or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of
35+
electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on
36+
electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for
37+
the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing
38+
by the copyright owner as "Not a Contribution."
39+
40+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and
41+
subsequently incorporated within the Work.
42+
43+
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual,
44+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display,
45+
publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
46+
47+
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide,
48+
non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell,
49+
sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are
50+
necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was
51+
submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work
52+
or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You
53+
under this License for that Work shall terminate as of the date such litigation is filed.
54+
55+
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications,
56+
and in Source or Object form, provided that You meet the following conditions:
57+
58+
1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
59+
60+
2. You must cause any modified files to carry prominent notices stating that You changed the files; and
61+
62+
3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices
63+
from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
64+
65+
4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a
66+
readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the
67+
Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the
68+
Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever
69+
such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License.
70+
You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work,
71+
provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to
72+
Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your
73+
modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with
74+
the conditions stated in this License.
75+
76+
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You
77+
to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above,
78+
nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
79+
80+
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except
81+
as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
82+
83+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides
84+
its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation,
85+
any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
86+
determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under
87+
this License.
88+
89+
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required
90+
by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages,
91+
including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the
92+
use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or
93+
any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
94+
95+
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a
96+
fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting
97+
such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree
98+
to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your
99+
accepting any such warranty or additional liability.
100+
101+
END OF TERMS AND CONDITIONS

0 commit comments

Comments
 (0)