diff --git a/README.md b/README.md index c11a9d1..87977b2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # next-arcgis-app -An ambitious ArcGIS application built with Next.js + +An example of how to use the [ArcGIS] platform in an application built with [Next.js]. + +![App screenshot](./screenshot.png) + +[View it live!](https://next-arcgis-app.now.sh/) + +This application uses [arcgis-rest-js](https://esri.github.io/arcgis-rest-js/) to authenticate users and search for items and the [ArcGIS API for JavaScript](https://developers.arcgis.com/javascript/) (via [esri-loader]) to show the extents of those items on a map. + +This is a [React] port of [ambitious-arcgis-app-2018](https://github.com/mjuniper/ambitious-arcgis-app-2018/). See that repository for more information on the motivation behind this application. + +See [create-arcgis-app](https://github.com/tomwayson/create-arcgis-app) a port of the same application built with [create-react-app](https://facebook.github.io/create-react-app/) instead of Next.js. + +See the [Next.js documentation](https://nextjs.org/docs#how-to-use) for more information on how to run this application locally after cloning the repository. + +[next.js]: https://nextjs.org/ +[arcgis]: https://www.arcgis.com/ +[esri-loader]: https://github.com/Esri/esri-loader +[react]: https://reactjs.org/ diff --git a/package.json b/package.json index 8e4b9c1..c380c46 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "next-arcgis-app", "version": "1.0.0", - "description": "An ambitious ArcGIS application built with Next.js", + "description": "An example of how to use the ArcGIS platform in an application built with Next.js.", "main": "index.js", "scripts": { "copy:auth": "cp ./node_modules/@esri/arcgis-rest-auth/dist/umd/auth.umd.min.js ./static/auth.umd.min.js", @@ -12,7 +12,9 @@ "prestart": "npm run copy:auth", "start": "next start", "test": "jest", - "test:watch": "jest --watch" + "test:watch": "jest --watch", + "predeploy": "npm run lint && npm run test", + "deploy": "now" }, "repository": { "type": "git", diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..7b7d3af Binary files /dev/null and b/screenshot.png differ