Commit 2cebae08 authored by Oyvind.Gjesdal's avatar Oyvind.Gjesdal

update readme

parent 93835074
Pipeline #84141 passed with stages
in 1 minute and 26 seconds
# Admin components
This repository contains all queries, templates and extra views for the Marcus administrative webpage (admin.marcus.uib.no). The framework used is [Semantic-UI](https://semantic-ui.com/).
This repository contains all queries, templates and extra views for the Marcus administrative webpage (admin.marcus.uib.no). The frontend framework used is [Semantic-UI](https://semantic-ui.com/) and Haanga, a django like framework.
This repo supports CI and builds the latest commit to [marcus admin test server](https://admin.marcus.ubbe.no/home) where changes can be viewed.
This repo runs CI and builds the latest commit to [marcus admin test server](https://admin.marcus.ubbe.no/home) on commit where changes can be viewed, , and also contains deployment to the production server.
The workflow could be described as
* open issue
* create merge request (from issue in GUI)
A possible workflow is:
* [open an issue](https://git.app.uib.no/uib-ub/spesialsamlingene/marcus-components/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=)
* create merge request (from issue in [web-GUI](https://git.app.uib.no/uib-ub/spesialsamlingene/admin-components/-/issues))
* push to merge request
* review/confirm changes/feature in [the test server](https://admin.marcus.ubbe.no/home)
* merge request to master
......@@ -17,10 +18,10 @@ The workflow could be described as
## Related projects
[ansible-marcus](https://git.app.uib.no/uib-ub/spesialsamlingene/ansible-marcus) sets up the marcus infrastructure, including admin endpoint.
[marcus search client (admin branch)](https://git.app.uib.no/uib-ub/spesialsamlingene/marcus-search-client/-/tree/admin) is the elasticsearch client.
* [ansible-marcus](https://git.app.uib.no/uib-ub/spesialsamlingene/ansible-marcus) sets up the marcus infrastructure, including admin endpoint.
* [marcus search client (admin branch)](https://git.app.uib.no/uib-ub/spesialsamlingene/marcus-search-client/-/tree/admin) is the elasticsearch client.
* [lodspeakr](https://git.app.uib.no/uib-ub/spesialsamlingene/marcus-lodspeakr) is the framework which uses the components. The components repo is usually placed in the components in the main directory.
* [marcus-components](https://git.app.uib.no/uib-ub/spesialsamlingene/marcus-components), [katalog.skeivtarkiv.no](https://git.app.uib.no/uib-ub/skeivtarkiv/katalog.skeivtarkiv.no) are other components repos
## Semantic UI
Configuration files used to change components
......@@ -29,33 +30,27 @@ semantic.json
./static/themes/default.theme.config
## Blackbox search
The blackbox search is
Edit theme in static/themes/uib. folder `uib` is then copied to `static/semantic/src/themes` before building
```
npm install
cd static/semantic/
npx gulp build
```
## Install Blackbox-search / Admin
The admin search contains a similar CI configuration in [marcus-search-client](https://git.app.uib.no/uib-ub/spesialsamlingene/marcus-search-client/-/tree/admin) where changes will be automitcally deployed to test, while prod can be updated from the UI.
## Local development/deployment
At the moment building this requires Node 6 which is past end of life support. It may be hard to set up locally.
```bash
# To install manually locally (don't use for prod or test servers, which are managed from the git repo)
## static/js/blackbox-search er i .gitignore
cd static/js/
mkdir blackbox-search
cd blackbox-search
git clone https://gitlab.com/ubbdev/marcus-search-client.git .
git checkout admin
# Følg installeringsguide til marcus-search-client (https://gitlab.com/ubbdev/marcus-search-client/-/tree/admin)
# Første steg:
cp default.semantic.json semantic.json
npm install
At the moment building `admin components` requires Node 6 which is past end of life support.
It may be hard to set up locally.
Inspect the [.gitlab-ci.yml](.gitlab-ci.yml) to view build steps.
### Old Installation instructions (not working?)
Configuration files used to change components
semantic.json
./static/themes/default.theme.config
Edit theme in static/themes/uib. folder `uib` is then copied to `static/semantic/src/themes` before building
```
npm install
cd static/semantic/
npx gulp build
```
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment