Skip to content

Commit

Permalink
replace grunt with npm scripts in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
campersau committed May 17, 2020
1 parent a2770d5 commit 2debb4a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Expand Up @@ -28,7 +28,7 @@ I do accept pull requests, but I also reserve the right to not do so for things

### What you need to get started

You'll need the same as for running Ungit; node, npm, and git. You will also need grunt (`npm install -g grunt-cli`).
You'll need the same as for running Ungit; node, npm, and git.

### Getting started

Expand All @@ -50,7 +50,7 @@ To provide easier access to launch ungit a standalone application container usin
#### To get started

1. Follow steps in 'Getting started' to get a development environment ready.
2. Run `grunt default && grunt package`. This will compile latest ungit and will create a standalone application package under `build/`
2. Run `npm run package`. This will create a standalone application package under `build/`

#### Known limitations

Expand All @@ -72,11 +72,11 @@ Ungit has two major parts; the server and the UI. The server exposes a REST inte
- `clicktests/` [puppeteer](https://pptr.dev/) click test; basically tests that run on the rendered DOM. Since these run all the way, from the DOM down to the server, they're also the most powerful of the tests.
- `components/` This directory contains all view components for Ungit, each of them exposed as an Ungit plugin.
- `public/` The UI web-app.
- `public/css/` CSS generated by the grunt script.
- `public/fonts/` & `public/images` Assets, some of which are compiled into the CSS by the grunt script, others (for instance those that are too large to compile into the CSS efficiently) are served directly.
- `public/js/` An ungit.js file generated by the grunt script, as well as raven files which handle exception logging.
- `public/css/` CSS generated by the npm build script.
- `public/fonts/` & `public/images` Assets, some of which are compiled into the CSS by less, others (for instance those that are too large to compile into the CSS efficiently) are served directly.
- `public/js/` An ungit.js file generated by the npm build script, as well as raven files which handle exception logging.
- `public/less/` Less files, which are the "source" used to generate the CSS.
- `public/source/` JavaScript source code, which is turned into the `public/js/ungit.js` file by the grunt script.
- `public/source/` JavaScript source code, which is turned into the `public/js/ungit.js` file by the npm build script.
- `public/vendor/` Various 3rd-party libs.
- `source/` Server and shared (i.e. used by both server and UI) source code.
- `test/` Unit tests and REST interface tests.
Expand Down

0 comments on commit 2debb4a

Please sign in to comment.