agrc / atlas

The UGRC template for creating single page mapping applications.

Atlas

UGRC Web Mapping Application Template

To Use

Step 1 - Use this template

Click the Use this template button to create a new repository from atlas or checkout the repository

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

Duplicate the .env file and rename it as .env.local to add your local secrets.

Install the project dependencies

npm install

Step 2 - Develop and Test

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

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

Build an awesome app.

Run npm test to run the unit tests

Run npm run format to format the code

Run npm run lint to lint the code

Step 3 - Optimize

Execute npm run build to create an optimized production build

The files will be placed in /dist

Execute npm run preview to view the built website

Step 4 - Deploy

This website is tested and deployed with GitHub Actions.

Contributing

See our Contributing Guide

Attribution

This project was developed with the assistance of GitHub Copilot.