TACC Core Components

The shared components for TACC WMA Workspace Portals & Websites

Important

No code. Outdated docs.

• Old attempt: develop.
• New attempt: #1

Related Repositories

• Core Portal, the base Portal code for TACC WMA Portals & Websites
• Core Styles, the custom UI pattern code for TACC WMA Portals & Websites

External Project Usage

1. Install the package with any package manager e.g.:

   • npm install TACC/Core-Components
   • yarn add TACC/Core-Components

2. Import components e.g.:

   • … (no example yet)
   • … (no example yet)

Local Development Setup

Prequisites for Building the Components

• Nodejs 17.x
• Typescript 4.x

Code Configuration

Code configuration happens in repos that use these styles.

Source Files

If you changes files in a source/ directory, you may need to follow some of these steps.

Quick Start

1. (optional) Make changes to /source files.
2. Transpile the styles: npm run build
3. (to debug) Review respective /dist files' content.

Testing

Plugin testing is done manually. Run npm run build from root folder in this project, then review output in /dist/_tests.css, to ensure plugins are working correctly.

Style testing is done manually. Run npm start from root folder in this project, then review output at web interface, to ensure styles are rendering correctly.

Production Deployment

The Core Components are not deployed alone.

For now, the stylesheets are acquired or accessed by other repositories.

Repo	Usage
Core CMS	via CLI installed on test branch

Contributing

Development Workflow

We use a modifed version of GitFlow as our development workflow. Our development site (accessible behind the TACC Network) is always up-to-date with main, while the production site is built to a hashed commit tag.

• Feature branches contain major updates, bug fixes, and hot fixes with respective branch prefixes:
  • task/ for features and updates
  • bug/ for bugfixes
  • fix/ for hotfixes

Best Practices

Sign your commits (see this link for help)

Resources

• Learn Markdown