Fabio/webssh2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: create building doc

Browse source
This commit is contained in:
Bill Church 2021-05-13 05:30:13 -04:00 committed by GitHub
parent 7f056fe355
commit 7b2086b668
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
BUILDING.md Normal file
View file

@ -0,0 +1,13 @@
# Buliding
To rebuild the client files, you need at least Node v10.
The source of the client files are located in `./app/client/source`
`npm run build` will compile the source files there into `./app/client/public/`. This directory is considered to be volitile and is deleted every time `npm run build` is invoked.
WebPack is used for building and the configuration is located in `./app/scripts`
If one wishes to make changes to the javascript, the html, or the css it should be done in `./app/client/source` and then complied using `npm run build`
For development purposes, you may also utilize `npm run builddev` which will not minimize the source and allow you to more easily troubleshoot while making customizations.