OpenBudget/budgetkey-app-search

Name: budgetkey-app-search

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

Description: This is the search interface budgetkey app.

Created: 2016-12-03 15:09:52.0

Updated: 2018-05-15 15:19:45.0

Pushed: 2018-05-21 18:15:40.0

Homepage: http://next.obudget.org/app/search

Size: 932

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

BudgetKey Search App

This is the search interface budgetkey app.

It currently can be accessed at http://next.obudget.org/app/search/

Quick Start (Set up a dev server)

1. Clone && cd into directory

2. npm install

3. npm run dist-serve

4. For Windows users - 1) run on one terminal npm run dist-serve

                 2) run on a  second terminal `npm start`
   

You should make sure you use the latest node v8.

If you have nvm installed, you can just run nvm install and you will have the correct version.

Basic functionality:

• It allows users to type in a free text query and get results from the Budget Key database.
• Results are received from the Search API.
• Results can be filtered by kind and time range.
• Results link to other parts of the web site.

Design mockups can be seen in issue #1.

Before starting, take a peek in our documentation

Generating Components, Directives, Pipes and Services

You can use the ng generate (or just ng g) command to generate Angular components:

enerate component my-new-component
 component my-new-component # using the alias

mponents support relative path generation
 in the directory app/feature/ and you run
 component new-cmp
ur component will be generated in app/feature/new-cmp
t if you were to run
 component ../newer-cmp
ur component will be generated in app/newer-cmp
 in the directory app you can also run
 component feature/new-cmp
d your component will be generated in app/feature/new-cmp

You can find all possible blueprints in the table below:

Scaffold | Usage — | — Component | ng g component my-new-component Directive | ng g directive my-new-directive Pipe | ng g pipe my-new-pipe Service | ng g service my-new-service Class | ng g class my-new-class Guard | ng g guard my-new-guard Interface | ng g interface my-new-interface Enum | ng g enum my-new-enum Module | ng g module my-module

angular-cli will add reference to components, directives and pipes automatically in the app.module.ts. If you need to add this references to another custom module, follow this steps:

1. ng g module new-module to create a new module
2. call ng g component new-module/new-component

This should add the new component, directive or pipe reference to the new-module you've created.

Note

To run the tests import karma-test-shim in the newly created *.spec.ts:

import 'karma-test-shim';

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": "??? ????"

To enable a theme, add the theme query parameter with a value matching a theme.THEME_NAME.json file available at the root of the project.

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-search .
er run -it -v `pwd`/my-theme.json:/app/theme.my-theme.json --rm --name budgetkey-app-search -p8000:8000 budgetkey-app-search

You could then add ?theme=my-theme to enable the theme