a.k.a. Uue Lewis and the Views
The Kiva UI project is bound by a Code of Conduct.
Kiva welcomes outside contributions to our UI repository. If you have any ideas for a feature or improvement, create an issue and we can discuss whether it makes sense to create a pull request. Thanks for the help!
IMPORTANT NOTE: Turn off Docker if it's running! We have a perpetually running network related to Tilt that will prevent Caddy from starting. I did consider using Tilt and docker-compose but it would require rewriting alot of the Monolith TiltVM setup so this just bypasses it all.
-
Add
127.0.0.1 kiva-ui.localto your/etc/hostsfile on your mac- Auth0 configs are already in place to support this domain in the dev tenant
-
Install Caddy
brew install caddy -
Start Caddy from the root of the ui repo
caddy startto run in the background orcaddy runkeep the terminal live for additional monitoring -
In a separate terminal at the root of the ui repo
# Set you node version using nvm
$ nvm use
# Install dependencies
$ npm ci
# Install husky git hooks (NOTE: This step only needs to be done once on first setup and powers pre-commit linting)
$ npx husky install
$ npm run dev -- --config=dev-custom-host
# The local dev URL is now: https://kiva-ui.local/, but make sure to access a page actually run by UI, for example https://kiva-ui.local/lend-by-category/women
-
To stop Caddy when you're done
caddy stop
# DEV MODE
# install dependencies
$ npm ci
# install husky git hooks (powers pre-commit linting)
$ npx husky install
# serve with hot reload at localhost:8888
$ npm run dev -- --config=local
# visit localhost:8888 for the home page
# visit localhost:8888/ui-site-map to explore our page index
# /styleguide, /lend-by-category, + /lend/filter are great to explore
# COMPILED/PROD MODE
# build for production with minification
$ npm run build
# build for production and view the bundle analyzer report
$ npm run build --report
# start the server using compiled build
$ npm start -- --config=local
# visit localhost:8888/ui-site-map to explore some pages (/styleguide or /lend-by-category may be of interest)
# run unit tests
$ npm run unit
# run all tests
$ npm test# DEV MODE
# Note: Kiva server only tool
# script to get status / get log / restart server / start_local
# copy to user home directory for global use
$ ./ui-server.sh {status|log|restart|local|start_local}
# install dependencies
$ npm install
# optionally install husky git hooks
$ npx husky install
# serve with hot reload at localhost:8888
$ npm run dev
$ npm run dev -- --config=local (any context outside of kiva vm)
# visit localhost:8888/ui-site-map to explore some pages (/styleguide or /lend-by-category may be of interest)
# Alternate configs:
# use `dev-local` to run localhost mode against development Environments
# use `dev-vm-mac` to run ui on your mac against the kiva vm
# COMPILED/PROD MODE
# build for production with minification
$ npm run build
# build for production and view the bundle analyzer report
$ npm run build --report
# start the server using compiled build
$ npm start -- --config=local
# visit localhost:8888/ui-site-map to explore some pages (/styleguide or /lend-by-category may be of interest)
# run unit tests
$ npm run unit
# run all tests
$ npm testFor some more details, checkout the template this is based on and the docs for vue-loader.