Overview:
The atlasUGRC Web Mapping Application Template is a template for creating web mapping applications. It provides a set of pre-built features and functionality that can be customized to create unique and interactive mapping applications.
Features:
- Pull Request Events: Receive notifications for pull request events, allowing for easier collaboration and tracking of changes.
- Push Events: Get updates on push events, giving visibility into commits and changes made to the codebase.
- Easy to Use: Simply use the template to create a new repository or clone and install dependencies to start developing and testing your web mapping application.
Installation:
To install and use the atlasUGRC Web Mapping Application Template, follow these steps:
- Click the “Use this template” button to create a new repository from the template. Alternatively, you can clone the repository and install the necessary dependencies.
- Duplicate the .env file and rename it as .env.local. Update the properties in the .env.local file with your own data.
- Download all the dependencies required for the template.
- Develop and test your application by executing
npm startto start a web server and view the website. You can opensrc/App.jsxto see the development version of the app. - Optional: Run unit tests with
npm test, functional tests withnpm run cypress:run, format the code withnpm run format, and lint the code withnpm run lint. - Once you are satisfied with your application, execute
npm run buildto create an optimized production build. The files will be placed in the/distfolder. - You can preview your website by running
npm run preview. - For deployment, update the analytics code in
index.html(a one-time task). - The website can be tested and deployed with GitHub Actions. Check out the Contributing Guide for more information.
Summary:
The atlasUGRC Web Mapping Application Template provides an easy and customizable way to develop web mapping applications. With features like pull request event notifications and push event updates, developers can collaborate efficiently and track changes made to their applications. The installation and development process is streamlined, making it accessible for users of all levels.