https://github.com/do-community/minify-tool

A web tool for the DigitalOcean Community to quickly minify JavaScript files
https://github.com/do-community/minify-tool

digitalocean-community-tools hacktoberfest javascript-minify minification minifier minify minify-javascript terser vue

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/do-community/minify-tool
• Owner: do-community
• License: apache-2.0
• Created: 2020-06-30T14:58:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T18:17:37.000Z (3 months ago)
• Last Synced: 2024-09-17T22:40:55.303Z (3 months ago)
• Topics: digitalocean-community-tools, hacktoberfest, javascript-minify, minification, minifier, minify, minify-javascript, terser, vue
• Language: Vue
• Homepage:
• Size: 4.69 MB
• Stars: 19
• Watchers: 7
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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

### [`src/minify-tool`](src/minify-tool)

#### [`src/minify-tool/scss`](src/minify-tool/scss)

The scss directory contains the main SCSS styling file for the tool, which imports our do-bulma

 library and then adds tool-specific customisations.

#### [`src/minify-tool/templates`](src/minify-tool/templates)

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.

#### [`src/minify-tool/i18n`](src/minify-tool/i18n)

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](CONTRIBUTING.md) before submitting your pull requests.