Techognito/starter-kit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs with build information

Browse source
This commit is contained in:
Dominik Perpeet 2017-07-25 13:36:09 +02:00
parent bbc70a004d
commit 22d5ea542b
2 changed files with 33 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -1,3 +1,4 @@
# Subscription-manager # Subscription-manager
**A Cockpit plugin to administer candlepin subscriptions** **A Cockpit plugin to administer candlepin subscriptions**
See [docs/build-notes.md](docs/build-notes.md) for more information on how to build and install this package.

35
docs/build-notes.md
View file

@ -28,11 +28,18 @@ This is the entry point for webpack, and will most likely contain the main paren
## Directory layout ## Directory layout
**TODO**: describe the high level layout of the folders, eg. component folder is for react components. The main package files are located in the [src](src) directory. These are processed during compilation and
packaging.
# Making a build ## Building
To actually build the plugin, simply run: You can use `make` to compile to code or `make install` to compile and install in `/usr/share/cockpit/`.
The convenience make targets `srpm` and `rpm` build the source and binary rpms, respectively. Both of these make
use of the `dist-gzip` target, which is used to generate the distribution tarball. In `production` mode, source files
are automatically minified and compressed. Set `NODE_ENV=production` if you want to duplicate this behavior.
Optionally, you can use `yarn` or `npm` to run the build, both of which in turn call `webpack`:
``` ```
yarn run build yarn run build
@ -52,3 +59,25 @@ users trying to build the plugin might have different versions of webpack instal
dependency, and then using yarn or npm to run a command, it will use the webpack version installed locally. dependency, and then using yarn or npm to run a command, it will use the webpack version installed locally.
[-yarnpkg]: https://yarnpkg.com [-yarnpkg]: https://yarnpkg.com
## Hacking with webpack
A fairly simple workflow for development uses webpack directly and doesn't require root privileges.
First, ensure that all dependencies are met and the code compiles:
```
npm install
make
```
Then, link the `dist` directory in a place where cockpit can find it, without installing to the system directory.
Call the following script from the git checkout:
```
ln -s ln -s ./dist subscription-manager
```
Then use webpack to monitor the filesystem for changes, also from the git checkout:
```
webpack --watch
```
After logging into Cockpit, you can refresh the page to load the newly built code after each change to the source files.