Skip to content

Commit e89ecbe

Browse files
committed
DOC: Added notes to Changelog, elaborate on Contributors, extended README by added .env file fields
1 parent 78d3fc5 commit e89ecbe

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

CHANGELOG.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This change log uses principles from `keep a changelog <http://keepachangelog.co
1010
Added
1111
^^^^^
1212

13+
- Customizable landing page.
1314
- Logout button.
1415
- Search result pagniation.
1516
- Selection of entry number per page.
@@ -20,6 +21,9 @@ Added
2021
Changed
2122
^^^^^^^
2223

24+
- Updated from bootstrap-vue-3 to bootstap-vue-next
25+
- Adapted routes to remodeled dserver REST API.
26+
2327

2428
Deprecated
2529
^^^^^^^^^^

CONTRIBUTORS.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
Contributors
22
============
33

4+
- Ashwin Vazhappilly added direct mongo query functionality, added logout
5+
button, adapted the webapp to remodeled dserver REST API, added customizable
6+
landing page.
7+
- Johannes L. Hörmann updated initial codebase from vue-2 to vue-3.
48
- Lars Pastewka added the ability to configure the dtool-lookup-server and
5-
token-generator URLs from environment variables
9+
token-generator URLs from environment variables.
10+
- Tjelvar S. G. Olsson wrote the initial webapp with vue-2.

README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,24 @@ Create a file `.env` in the `dtool-lookup-webapp` directory with the following c
3636

3737
For deployment, replace these URLs with the actual endpoints of the lookup server and the token generator.
3838

39+
If desired, customize the landing page by setting the following variables in the `.env` file:
40+
41+
::
42+
43+
VUE_APP_FIRST_CONTAINER_TITLE=Log in
44+
VUE_APP_SECOND_CONTAINER_TITLE=dserver
45+
VUE_APP_SECOND_CONTAINER_MESSAGE=Welcome to <b>dserver</b>'s webapp.
46+
VUE_APP_THIRD_CONTAINER_HEADING=Access
47+
VUE_APP_THIRD_CONTAINER_MESSAGE=Some notes on how to gain access.
48+
VUE_APP_FOURTH_CONTAINER_HEADING=Docs
49+
VUE_APP_FOURTH_CONTAINER_INTRO=Some notes on how to find help. The following list may contain an arbitrary number of links.
50+
VUE_APP_FOURTH_CONTAINER_RESOURCES=[{"text": "dtool-lookup-webapp repsotiory", "url": "https://github.com/jic-dtool/dtool-lookup-webapp"}]
51+
VUE_APP_LANDING_PAGE_ICON_PATH=/path/to/custom/icon.png
52+
53+
To apply changes to this file, run::
54+
55+
npm install
56+
3957

4058
Start a development server
4159
--------------------------

0 commit comments

Comments
 (0)