Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samk13/invenio-theme-kth
https://github.com/samk13/invenio-theme-kth
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samk13/invenio-theme-kth
- Owner: Samk13
- License: mit
- Created: 2022-11-24T22:04:25.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T22:52:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T22:12:26.853Z (3 months ago)
- Language: JavaScript
- Size: 230 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
Awesome Lists containing this project
README
# invenio-theme-kth
This module provides templates overrides and modification to invenio default theme:
- Customization of templates and modifications to the Invenio default theme are provided by this module
- Adding terms of use check box to the registration process when using third-party authentication services such as ORCID before registration.
## Installation
```bash
pip install invenio-theme-kth
```
## Components
`views.py`: provides a Blueprint that registers both the static/ and templates/ folders to be usable by Invenio
`webpack.py`: registers the front-end assets (in the assets/ folder) to webpack
`config.py`: overrides several configuration items related to theming Invenio If new files is been added, first run:
## Maintainers
This section intended for you who want to further develop this module.
### Last Updated
> invenio RDM V11
### Maintaining
Keep the following files up to date with source:
[RDMDepositFormOverride.js](invenio_theme_kth/assets/semantic-ui/js/invenio_theme_kth/deposit/RDMDepositFormOverride.js) with
[Source RDMDepositForm.js](https://github.com/inveniosoftware/invenio-app-rdm/blob/master/invenio_app_rdm/theme/assets/semantic-ui/js/invenio_app_rdm/deposit/RDMDepositForm.js)
[index.js](invenio_theme_kth/assets/semantic-ui/js/invenio_theme_kth/deposit/index.js) with [Source index.js](https://github.com/inveniosoftware/invenio-app-rdm/blob/master/invenio_app_rdm/theme/assets/semantic-ui/js/invenio_app_rdm/deposit/index.js)
Update translations:
[Follow the steps here](.tx/config)
## Local setup
```bash
make install
# if you use pyenv
make install-pipenv
make test
```
while working on assets you can watch the assets with
```bash
invenio-cli assets watch
```
When you are done with your development
```bash
invenio-cli assets build
```
## Upload to pypi
```console
make package-create
make package-upload USER="" PASS=""
```
- `make package-create` command will:
1. remove old dist folder
2. auto increment package version
3. zip the package into dist dir
4. check if the package pass twin checks
> You can change version increment to major or minor by adding ARG:
- `make package-create ARG="-ma"` increment major version
- `make package-create ARG="-mi"` increment minor version
- `make package-create` increment patch version
- `make package-check` # verify if the package pass twine checks
- `make package-upload USER="" PASS=""` # will and upload to pypi will prompt for username and pass
or manually:
twine upload -u -p dist/* --verbose