AGRC's boilerplate for JavaScript applications.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix: head cold mistakes Dec 17, 2018
data chore: merge with other repository Dec 17, 2018
forklift
maps chore: merge with other repository Dec 17, 2018
mockups chore: merge with other repository Dec 17, 2018
public chore: merge with other repository Dec 17, 2018
scripts
src
.env
.env.test
.gitattributes
.gitignore
.htmlhintrc
.travis.yml get newer version of npm Jun 15, 2018
GruntFile.js chore: merge with other repository Dec 17, 2018
LICENSE.md chore: merge with other repository Dec 17, 2018
README.md docs: simplify and update readme steps Dec 17, 2018
SpecHeadless.js chore: merge with other repository Dec 17, 2018
package-lock.json chore: merge with other repository Dec 17, 2018
package.json
secrets.sample.json

README.md

atlas

AGRC JavaScript Project Boilerplate

Build Status

To Use

Step 1 - Boilerplate

Checkout repository and install dependencies

git clone https://github.com/agrc/atlas.git
cd atlas
npm install

Duplicate the .env file and rename it as .env.development.local and update the properties with your data

Step 2 - Develop & Test

Execute npm start to start a web server and view the website

Open src/App.js to view the development version of the app.

Build an awesome app.

Execute npm test to run tests

Step 3 - Optimize

Execute npm run build to create an optimized production build

The files will be placed in /build

Execute serve -s build to view the website

Step 4 - Deploy

One-time tasks:

  • Update the analytics code in public/index.html
  • Create and populate secrets.json based on secrets.sample.json

Tasks to be completed for each release:

  • Semantically update .env property REACT_APP_VERSION and package.json version
  • Update public/changelog.html
  • Verify all tests are passing (npm test)
  • Run a build and test (npm run build)
  • Deploy website (grunt deploy-prod)
  • Create release commit (git commit -m 'chore: Release vx.x.x)
  • Create tag (git tag vx.x.x)
  • Push commits and tag to github (git push origin && git push origin --tags)

Notes

A WASM MIME type that is used in the Esri JS API (geometry engine) is defined in web.config. This will cause a server error in IIS if you have the same type defined in a parent directory. If you experience this error you will need to remove one of the duplicate MIME type definitions.