Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Improve the frontend build process.

This commit is contained in:
Yago González 2017-03-07 22:32:43 +00:00 committed by Tim Abbott
parent d52e08a25c
commit 155978fefd
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/front-end-build-process.md
View File

@ -7,9 +7,10 @@ overview, see the [new feature tutorial](new-feature-tutorial.html).
## Primary build process ## Primary build process
Most of the existing JS in Zulip is written in IIFE-wrapped modules, Most of the existing JS in Zulip is written in
one per file in the `static/js` directory. When running Zulip in [IIFE](http://benalman.com/news/2010/11/immediately-invoked-function-expression/)-wrapped
development mode, each file is loaded separately, to make reloading modules, one per file in the `static/js` directory. When running Zulip
in development mode, each file is loaded separately, to make reloading
nice and efficient. In production mode (and when creating a release nice and efficient. In production mode (and when creating a release
tarball using `tools/build-release-tarball`), JavaScript files are tarball using `tools/build-release-tarball`), JavaScript files are
concatenated and minified. We use the concatenated and minified. We use the
@ -29,7 +30,8 @@ add it to the appropriate place under `static/`.
You'll want to add these to the `package.json` in the root of the You'll want to add these to the `package.json` in the root of the
repository, and then provision (to have `npm` download them) before repository, and then provision (to have `npm` download them) before
continuing. Your commit should also update `PROVISION_VERSION` in continuing. Your commit should also update `PROVISION_VERSION` in
`version.py`. `version.py`. When adding modules to `package.json`, please use
specific versions of them (without using carets `^`, tildes `~`, etc).
- Third-party files that we have patched should all go in - Third-party files that we have patched should all go in
`static/third/`. Tag the commit with "[third]" when adding or `static/third/`. Tag the commit with "[third]" when adding or
modifying a third-party package. Our goal is to the extent possible modifying a third-party package. Our goal is to the extent possible