Skip to content

cdlib/intracdl-ui

Repository files navigation

IntraCDL UI

The user interface for the IntraCDL website.

View at: https://cdlib.github.io/intracdl-ui

This includes a developer toolkit using the Fractal component library and Parcel build tool.

Installation

Requires Node, npm and Font Awesome Pro token.

  1. Add the Font Awesome Pro token as a GitHub Actions secret named FONTAWESOME_TOKEN.

  2. Add a .npmrc file within the project root using the Per-Project settings for Font Awesome Pro, including your token. This file is automatically ignored by Git and should not be committed.

  3. Run npm install.

Developing

  1. Run npm run serve

This will watch and compile .hbs, .css, .js, and /images/ files as you work on them.

  1. Go to http://localhost:3000 to view pages, components ane elements within the Fractal web interface.

To test the UI on other devices (phone, tablet, etc.), use the Fractal Server Network URL listed in your CLI at first run.

Building

Run npm run build.

All UI assets, including main.css, main.js, minified images and font files will be compiled to /dist/.

Publishing to GitHub Pages

  1. Select GitHub Actions from the the Build and deployment source from the GitHub Pages section within the Settings menu.

  2. Add a Font Awesome Pro GitHub Action secret by copying the token applied to the .npmrc file (described in the Installation section above) and pasting it as: FONTAWESOME_TOKEN. How to add GitHub Action secrets.

Pages, components and elements within the Fractal Web interface will be published to your GitHub Pages URL upon each push to the repository.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published