Skip to content

do-community/minify-tool

Repository files navigation

JavaScript Minify Tool

A web tool for the DigitalOcean Community to quickly minify JavaScript files.


Development/Building

To setup the build/develop environment, you will need to run npm ci with Node 12+ installed. This will install the dependencies to allow you to build the project, following our lockfile.

To develop for this tool run npm run dev. This will start a development server that will automatically reload the codebase when changes occur.

If you wish to host this tool on a service, simply run npm run build. This will run all the necessary build scripts automatically to build the tool.
You can then take the dist folder and put it on your web server/bucket.

GitHub Actions is setup to do this automatically for this repository to deploy to gh-pages.

Source Structure

The scss directory contains the main SCSS styling file for the tool, which imports our do-bulma library and then adds tool-specific customisations.

This directory contains the Vue templates that are used to render the tool on the client-side. app.vue is the main Vue file that other templates are referenced into.

All the strings for the tool are housed in this directory, with a file structure similar to the structure of the templates directory.

Contributing

If you are contributing, please read the contributing file before submitting your pull requests.