An open API service indexing awesome lists of open source software.

https://github.com/azmag/mag-vite-react-template

This repo is a Maricopa Associations of Governments (MAG) template to create a react project using Vite.
https://github.com/azmag/mag-vite-react-template

esri-javascript-api mag react scaffolding template-project template-repository vite

Last synced: about 1 month ago
JSON representation

This repo is a Maricopa Associations of Governments (MAG) template to create a react project using Vite.

Awesome Lists containing this project

README

          

# mag-vite-react-template

## MAG Vite React Template

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/AZMAG/mag-vite-react-template?&logo=github&style=flat-square)](https://github.com/AZMAG/mag-vite-react-template/releases)
![GitHub Release Date](https://img.shields.io/github/release-date/AZMAG/mag-vite-react-template?&logo=github&style=flat-square)
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/AZMAG/mag-vite-react-template?style=flat-square)
![semver](https://img.shields.io/badge/semver-2.0.0-blue?style=flat-square)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)

## :key: Keywords

`mag` `vite` `react` `esri-javascript-api` `template`

## What is the MAG Vite React Template?

This project provides a basic dev setup intended for quickly setting up a MAG project that uses Vite and React. It contains all of the necessary dependencies and configuration to get started with a new project.

## How to use this template

### Installation

If you haven not already installed degit, install it globally with npm:

```bash
npm install -g degit
```

### Getting Started

The simplest use of degit is to download the master branch of this repo from GitHub to your current working directory:

#### Create a new folder for the project

If the second argument is omitted, the repo will be cloned to the current directory.

```bash
For example:
degit user/repo my-new-project
```

```bash
degit AZMAG/mag-vite-react-template [my-new-project]
```

or

```bash
degit https://github.com/AZMAG/mag-vite-react-template/[my-new-project]
```

## Version

### version | 1.2.1

- #### Updated | 2024-09-13

- #### Created | 2024-09-13

Releases will be numbered with the following format: **`..`**

And constructed with the following guidelines:

1. **MAJOR** version when you make incompatible API changes **bumps the major** resets minor and patch
2. **MINOR** version when you add functionality in a backwards-compatible manner **bumps the minor** resets patch
3. **PATCH** version when you make backwards-compatible bug fixes and misc changes **bumps only the patch**

## Issues Labels

### git-labelmaker

Edit GitHub labels from the command line using `git-labelmaker`. You can easily add or remove GitHub labels, making it easier for your projects to adhere to a labelling scheme.

For more information - [git-labelmaker](https://github.com/himynameisdave/git-labelmaker)

Run the command and follow the prompts - `git-labelmaker`

#### Labels

- [github-labels.json](github-labels.json)

## Technologies

A list of technologies used within the project:

JavaScript
JavaScript
ECMAScript 6
HTML5
CSS3
React
Tailwind CSS
Vite
KendoReact
Font-Awesome
ESLint
Prettier
npm
Git
vscode

## :star: Credits

`Maricopa Association of Governments (MAG) and the MAG member agencies`

## :zap: Disclaimer

- [DISCLAIMER](DISCLAIMER.md)

## :warning: Licensing

Copyright 2024 Maricopa Association of Governments (MAG)

This project is licensed under the MIT license.

- [LICENSE](LICENSE)

[(Back to top)](#mag-vite-react-template)