Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usgs/pubswh-ui
Publications Warehouse UI - both public facing and manager interface
https://github.com/usgs/pubswh-ui
flask pubswh
Last synced: 19 days ago
JSON representation
Publications Warehouse UI - both public facing and manager interface
- Host: GitHub
- URL: https://github.com/usgs/pubswh-ui
- Owner: usgs
- License: other
- Created: 2019-07-25T20:39:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-03T19:51:27.000Z (over 3 years ago)
- Last Synced: 2024-04-14T13:53:08.815Z (9 months ago)
- Topics: flask, pubswh
- Language: JavaScript
- Homepage: https://pubs.er.usgs.gov/
- Size: 93.8 MB
- Stars: 3
- Watchers: 11
- Forks: 10
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# USGS Publications Warehouse User Interface
[](https://travis-ci.com/usgs/pubswh-ui)
[](https://www.codacy.com/app/usgs_wma_dev/pubswh-ui?utm_source=github.com&utm_medium=referral&utm_content=usgs/pubswh-ui&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/usgs/pubswh-ui)
The Pubs Warehouse provides access to over 150,000 publications written by USGS
scientists over the century-plus history of the bureau.
This repo contains the front-end components of the Publications Warehouse:
- [`server`](server): A Flask web application that is used to create server-rendered pages
- [`assets`](assets): Client-side Javascript, CSS, images, etc.
This application should be built using Python 3.X and Node.js version > 10.x.x.
## Local Development - Makefile configuration
Application configuration may be specified by creating an instance config in server/instance/config.py. This
configuration overrides variables in the default one (server/config.py). The make env target will copy a
sample, server/config.py.sample, as a convenience if one doesn't exist. By default these will point to
production services.
### Install dependencies
The repository contains a make target to configure a local development environment:
```bash
make env
```
To manually configure your environment, please see the READMEs of each separate project.
### Development server
To run all development servers in a watch mode at the same time, use the make target:
```bash
make watch
```
... and to run each dev server individually:
```bash
make watch-server
make watch-assets
```
The make env command will create a config.py in the ```server/instance``` directory if one
does not exist by copy the file ```server/config.py.sample``` to the directory. Any config
variable defined in ```server/config.py``` can be overridden by assigning a value
to that variable in the ```server/instance/config.py``` file. Please note that
variables that are required (as described in the Docker section below) must have
values in ```server/instance/config.py```
See the specific project READMEs for additional information.
- [Flask Server README](./server/README.md)
- [Assets README](./assets/README.md)
### Run tests
To run all project tests:
```bash
make test
```
### Production build
```bash
make build
```
### Clean targets
```bash
make clean ; clean build artifacts
make cleanenv ; clean environment configuration and build artifacts
```
`make` supports chaining targets, so you could also `make clean watch`, etc.
## Local Development - Docker configuration
Two containers are provided - one for node-based build tooling, the second for
a Python server container. You will need to have a clean directory before starting.
```bash
make cleanenv
```
### Docker Build
```bash
docker-compose build
```
There are three build_args that can be used to add additional arguments to the npm, bower, and pip install steps
```text
--build-arg npm_args=--options --build-arg=pip_install_args=--options --build-arg bower_args=--config.options
```
### Docker Development server
You will need to provide the environment variables needed to run the application. The environment variables that
can be read can be found in ```server/config.py```. Set the appropriate environment
variables in the `local.env` file in the root directory of the project. Note that if ```server/instance/config.py```
is not empty, it's contents will override the environment variables set below. If you may use that rather than create
```local.env```. Example `local.env` file:
```text
SECRET_KEY=
PUB_URL=
LOOKUP_URL=
BASE_SEARCH_URL=
JSON_LD_ID_BASE_URL=
PREVIEW_ENDPOINT_URL=
PUBSAUTH_CLIENT_ID=
PUBS_AUTH_CLIENT_SECRET=
PUBSAUTH_ACCESS_TOKEN_URL=https://www.sciencebase.gov/auth/realms/PubsWH/protocol/openid-connect/token
PUBSAUTH_AUTHORIZE_URL=https://www.sciencebase.gov/auth/realms/PubsWH/protocol/openid-connect/auth
PUBSAUTH_API_BASE_URL=https://www.sciencebase.gov/auth/realms/PubsWH/protocol/openid-connect
STATIC_ROOT=http://localhost:9000
```
In addition, the following optional environment variables should be set appropriately. If not set they will be
the empty string unless otherwise noted
```text
DEBUG=
JS_DEBUG=
LOGGING_ON=
NO_VERIFY_CERT=
RECAPTCHA_PRIVATE_KEY=
WSGI_STR=
GOOGLE_ANALYTICS_CODE=
GOOGLE_WEBMASTER_TOOLS_CODE=
ANNOUNCEMENT_BLOCK=
ROBOTS_WELCOME=
CACHE_TYPE=
CACHE_REDIS_HOST=
CACHE_KEY_PREFIX=
REDIS_CONFIG=
IMAGES_CACHE=
SCIENCEBASE_PARENT_UUID=
GA_KEY_FILE_PATH=< path to the location of the google analytices service account key>
ALTIMETRIC_KEY=
ASSET_MANIFEST_PATH=
```
```bash
# Run in the foreground
docker-compose up
# Run in the background
docker-compose up -d
# Run just the Python dev server on port 5050
docker-compose up server
# Run just the node.js build server on port 9000
docker-compose up assets
```
### Docker run tests
```bash
# Run Python server tests
docker-compose -f docker-compose.yml -f docker-compose.ci.yml run -u root server
# Run Javascript tests
docker-compose -f docker-compose.yml -f docker-compose.ci.yml run assets
```