Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cheminfo/flavor-builder

Visualize website generator

https://github.com/cheminfo/flavor-builder

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.0%) to scientific vocabulary

Keywords from Contributors

nmr nmr-spectroscopy projection archival interactive generic unidata sequences jcamp data-format
Last synced: 11 months ago · JSON representation

Repository

Visualize website generator

Basic Info
  • Host: GitHub
  • Owner: cheminfo
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Size: 941 KB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 1
  • Open Issues: 4
  • Releases: 9
Created over 11 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog License

README.md

flavor-builder

Visualizer website generator

Test the build

To test the build, run:

bash DEBUG=flavor-builder:info node bin/build.js --config=./configs/cheminfo.json

There are other build configurations available in the configs directory to test.

As configured by configs/cheminfo.json, this will write to the build directory:

  • cheminfo-revisions.json and cheminfo-md5.json which keep track of what has been updated.
  • out directory which contains the result of the build

Build the admin page by running:

bash mkdir build/out/on-tabs node node_modules/visualizer-on-tabs/bin/build.js --outDir=$(realpath ./build/cheminfo/out/on-tabs/) --config=$(realpath ./configs/on-tabs.json)

To test the built website using apache, run:

bash docker compose up -d

Home page: http://localhost:6060 Example of on-tabs page: http://localhost:6060/flavor/eln/reaction/index.html

If you built the admin page, you can access it at: http://localhost:6060/on-tabs/

Build with couchdb authentication

If access to the CouchDB database is protected, use the COUCHDB_USER and COUCHDB_PASSWORD environment variables to provide the credentials.

For example, assuming you have a working couchdb instance on localhost:5984, you could run:

bash DEBUG=flavor-builder:info COUCHDB_USER=admin COUCHDB_PASSWORD=<FILL_PASSWORD_HERE> node bin/build.js --config=./configs/scipeaks.json

````bash

Test an alternative build

Use your own configuration or build from one of the existing ones in the configs directory.

```bash DEBUG=flavor-builder:info node bin/build.js --config=./configs/flavor-1024.json

Will serve build/flavor-1024/out/ on port 6060

SERVE_DIR=flavor-1024 docker compose up -d open http://localhost:6060/ ````

Warning The on-tabs page is not fully functional in this setup.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

TODO: example with couch authentication.

CLI usage

To force the rebuild you should add the option --forceUpdate.

Docker image

This repository publishes a docker image on github.

It is responsible for building static assets but not for running a web server like apache or nginx.

  • The outputs of the builds are written to /var/www/html/ base directory on the container.
  • Runs a command when the container starts that builds the visualizer admin page to the on-tabs directory, based on the /on-tabs-config.json configuration file.
  • Runs a command every minute which builds pages to the base directory based on the /flavor-config.json configuration file.

Owner

  • Name: Cheminfo
  • Login: cheminfo
  • Kind: organization

GitHub Events

Total
  • Release event: 1
  • Delete event: 4
  • Issue comment event: 4
  • Push event: 8
  • Pull request event: 10
  • Create event: 10
Last Year
  • Release event: 1
  • Delete event: 4
  • Issue comment event: 4
  • Push event: 8
  • Pull request event: 10
  • Create event: 10

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 390
  • Total Committers: 8
  • Avg Commits per committer: 48.75
  • Development Distribution Score (DDS): 0.21
Past Year
  • Commits: 5
  • Committers: 2
  • Avg Commits per committer: 2.5
  • Development Distribution Score (DDS): 0.2
Top Committers
Name Email Commits
Daniel Kostro k****d@g****m 308
Michaël Zasso t****s@p****m 30
greenkeeperio-bot s****t@g****o 22
cheminfo bot a****n@c****g 20
Luc Patiny l****c@p****m 4
virago bot t****g@f****m 2
dependabot[bot] 4****] 2
lpatiny g****3 2
Committer Domains (Top 20 + Academic)
firmenich.com: 1 patiny.com: 1 cheminfo.org: 1 greenkeeper.io: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 22
  • Total pull requests: 87
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 months
  • Total issue authors: 3
  • Total pull request authors: 7
  • Average comments per issue: 1.23
  • Average comments per pull request: 0.3
  • Merged pull requests: 54
  • Bot issues: 0
  • Bot pull requests: 25
Past Year
  • Issues: 0
  • Pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.09
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • stropitek (10)
  • targos (7)
  • lpatiny (5)
Pull Request Authors
  • greenkeeperio-bot (25)
  • dependabot[bot] (25)
  • stropitek (16)
  • cheminfo-bot (13)
  • bjonnh (2)
  • lpatiny (2)
  • targos (1)
Top Labels
Issue Labels
bug (2) question (1)
Pull Request Labels
dependencies (25) greenkeeper (25) autorelease: pending (8) autorelease: tagged (5)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 154 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 1
  • Total versions: 56
  • Total maintainers: 4
npmjs.org: flavor-builder

Make an indexable website from a flavor (a bunch of views in the visualizer)

  • Versions: 56
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 154 Last month
Rankings
Dependent packages count: 8.9%
Dependent repos count: 10.4%
Forks count: 11.6%
Average: 13.1%
Downloads: 13.8%
Stargazers count: 21.0%
Maintainers (4)
cheminfo-bot targos lpatiny stropitek
Last synced: 12 months ago

Dependencies

package-lock.json npm
  • 777 dependencies
package.json npm
  • eslint ^7.29.0 development
  • eslint-config-cheminfo ^5.2.4 development
  • inquirer ^8.1.1 development
  • co ^4.6.0
  • debug ^4.3.1
  • flavor-utils ^3.2.0
  • fs-extra ^10.0.0
  • is-running ^2.1.0
  • lodash ^4.17.21
  • minimist ^1.2.5
  • request ^2.79.0
  • swig ^1.4.2
  • visualizer-on-tabs git+https://github.com/cheminfo/visualizer-on-tabs#3a433a29441a7397352b3d03aa48bf769f4f980b
.github/workflows/dockerimage.yml actions
  • actions/checkout v2 composite
.github/workflows/nodejs.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2 composite
.github/workflows/release.yml actions
  • GoogleCloudPlatform/release-please-action v2 composite
Dockerfile docker
  • node 16-slim build
docker-compose.yml docker
  • httpd 2-alpine