Skip to content

Commit

Permalink
minor www-lib change to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nkosilathi Vundla authored Aug 20, 2021
1 parent 03f41cc commit 2e558ad
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ A skeleton project to demonstrate a minimal setup of an IMQS frontend app levera

## To use this as a template
1. Copy all code from this repo to your new repository
1. Add `www-lib` submodule: `git add submodule git@github.com:IMQS/www-lib.git www/src/lib`
1. Find and replace all occurances of `wwwtemplate` in this repository with your project name.

## To run from commandline
Expand All @@ -13,6 +12,9 @@ A skeleton project to demonstrate a minimal setup of an IMQS frontend app levera
1. Run: `wwwtemplate.exe -c config_sample/config.json`
1. Open [`http://localhost/wwwtemplate/www/`](http://localhost/wwwtemplate/www/) (trailing slash is required) and you should see the app running.

## IMQS packages
1. Add imqs packages that are required from [@imqs](http://js.imqs.co.za:4873/), by using npm install. For more information on imqs packages consult [this page](https://imqssoftware.atlassian.net/wiki/spaces/AR/pages/1291813060/Typescript).

## Front-end Development
1. Change directory to `/www`
1. Run `npm run dev` to build an in-memory version of the build artifacts. This will live-update the app as you develop.
Expand Down

0 comments on commit 2e558ad

Please sign in to comment.