Skip to content

Latest commit

 

History

History
143 lines (101 loc) · 6.81 KB

README.md

File metadata and controls

143 lines (101 loc) · 6.81 KB
Raw

Open Data Upstate / Greenville SC Map Layers Demo

All Contributors

![All Contributors][all-contributors-logo] Continuous Integration

This is a Vue project which allows all you to dynamically toggle on/off any of the Upstate / Greenville SC open map data layers!

Contributions to this project or the map data is greatly appreciated! You can join the HackGreenville Slack #hg-labs channel to get involved. Or, comment on issues or pull requests on this repository.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

I also recommend using asdf version manager to install the correct version of Node.JS for this project. Then, you can follow the instructions to install the Node.JS asdf plugin, and the Node.JS version will be installed for this directory only.

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit:dev

Reset Cached API Responses (Called Tapes) Used by Vitest This project utilizes the talkback package to save responses received from external dependencies into fixtures (called tapes) that can be used in subsequent set suite executions.

If the upstream data source's response schema is altered you can run the following command to "freshen things up" and overwrite any previously recorded responses:

OVERWRITE_TAPES=1 npm run test:unit:dev

Run End-to-End Tests with Cypress

npm run test:e2e:dev

This runs the end-to-end tests against the Vite development server. It is much faster than the production build.

Run all tests:

This will run all unit and end to end tests, as well as type and formatting checks in preparation for a pull request:

npm run test:all

Lint with ESLint and Prettier

This will format all the files for you automatically!

npm run lint

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Olivia Sculley
Olivia Sculley
🤔 💻 ⚠️ 🚧 🚇 🐛 📖		 Matthew Thornton
Matthew Thornton
💻 ⚠️		 Alex Grimes
Alex Grimes
💻 ⚠️ 🎨 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!