Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.86 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.86 KB
Raw

Unminify Website

About

This is a website for the Unminify tool.

It is available at unminify.io.

Usage

  1. $ npm install to install dependencies.
  2. $ npm run test to load a http server.
  3. Navigate to http://127.0.0.1:8080 to view the site (or alternate port if 8080 was in use, see the test command output).

Updating

  1. $ npm install to install dependencies.
  2. $ npm run build:lib to regenerate the shipped version of Unminify.
  3. $ npm run vendor to regenerated the shipped version of the UI.

Contributing

  • Open a Github issue with a description of your desired change. If one exists already, leave a message stating that you are working on it with the date you expect it to be complete.
  • Fork this repo, and clone the forked repo.
  • Install dependencies with $ npm install.
  • Build and test in your environment with $ npm run test. Note that testing is manual verification in a browser.
  • Create a feature branch. Make your changes. Add tests.
  • Build and test in your environment with $ npm run test. Note that testing is manual verification in a browser.
  • Make a commit that includes the text "fixes #XX" where XX is the Github issue.
  • Open a Pull Request on Github.

License

Copyright 2018 Shape Security, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.