OpenBudget/budgetkey-app-generic-item

Name: budgetkey-app-generic-item

Owner: ?????? ?? ??????

Description: null

Created: 2017-02-27 20:02:05.0

Updated: 2018-05-22 22:09:10.0

Pushed: 2018-05-22 22:09:09.0

Homepage: null

Size: 988

Language: Jupyter Notebook

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Budget Key Generic Item Page

This is a generic item page for the Budget Key project.

To read on how it's used, please take a look here.

Quick Start (Set up a dev server)

1. Clone && cd into directory
2. npm install
3. npm run dist-serve
4. example app url which should be available: http://localhost:8000/org/association/580050789

You should make sure you use the correct node version, at time of writing it's v8.3.0. If you have nvm installed, you can just run nvm install and you will have the correct version.

Themes

The core components and apps support themes for reusability of common code.

To run the app with a different theme, you need to set the theme in theme.THEME_NAME.json

For example, theme.govbuy.json:

UDGETKEY_NG2_COMPONENTS_THEME": {
"siteName": "??? ????"

UDGETKEY_APP_GENERIC_ITEM_THEME": {
"siteName": "??? ????",
"searchPlaceholder": "???? ???!"

To enable a theme, add it to the URL, e.g. http://localhost:8000/org/association/580050789?theme=govbuy

The theme files could be overwritten by docker volume - to allow to use the same image to serve the app using different themes.

For example, given a modified theme in ./my-theme.json:

er build -t budgetkey-app-generic-item .
er run -it -v `pwd`/my-theme.json:/app/theme.my.json --rm --name budgetkey-app-generic-item -p8000:8000 budgetkey-app-generic-item

You could then add ?theme=my to enable this theme