DEVELOPER.md

Developer

This document describes how to set up your development environment to build and develop mango-ui.

• Prerequisite Software
• Code Editor
• Getting the Sources
• Installing NPM Modules
• Start Development Server
• Building For Production
• Cleaning

Prerequisite Software

Before you can run mango-ui you must install and configure the following products on your development machine:

• Git and/or the GitHub app; GitHub's Guide to Installing Git is a good source of information.

• Node.js LTS which is used to run a development web server, and generate distributable files. We recommend using the Node Version Manager (NVM) to install Node.js and NPM on your machine. Once you have NVM installed you can use the required Node.js/NPM versions via:

  cd mango-ui
  nvm use

Code Editor

The recommended editor for developing mango-ui is VS Code with the following settings and extensions. You can easily use another editor of your choice as long as you can replicate the code formatting settings.

Settings.json

Your editor should follow the same settings found in .vscode/settings.json.

Extensions

1. Prettier - Code formatter
2. ESLint
3. Stylelint
4. EditorConfig for VS Code
5. Vitest
6. Path Intellisense
7. Code Spell Checker

Getting the Sources

Clone the mango-ui repository:

cd mango-ui

Installing NPM Modules

Install the JavaScript modules needed to build mango-ui:

npm install

Start Development Server

Run npm run dev for a dev server. Navigate to http://localhost:5173/. The app will automatically reload if you change any of the source files.

Building For Production

Run npm run build to build a production version of the project. The build artifacts will be stored in the build/ directory.