wesleyboar / core-workspace

A solution to simultaneously develop TACC Portals & Websites.

⚠ Only Core CMS and Core Styles are supported and tested. ⚠️

TACC Core Workspace

Sample workspace for simultaneous development of TACC WMA Workspace Portals & Websites.

The key provision is merely workspaces in pacakage.json to set up NPM workspaces. This template repository just offers guidance and convenience scripts.

Related Repositories

• Core CMS, the base CMS code for TACC WMA CMS Websites
• Core Portal, the base Portal code for TACC WMA CMS Websites
• Core Styles, the shared UI pattern code for TACC WMA CMS Websites
• Core Components, the shared JS components for TACC WMA CMS Websites

Local Development Setup

1. Clone/Move Core CMS and Core Styles into this root directory.
   • After cloning, follow each package's README instructions.
   • Moving an existing repository works just as well.
2. Install package dependencies, from root, via npm install.

Using the Packages

Each package:

• shares dependencies (which have been hoisted to root)
• can load each other as if the other is an NPM package
• supports development of it independent of sibling packages

(Optional) Convenience Scripts

These scripts let you run one or more specific package scripts.

• Run, from root, a convenience script e.g.:
  • npm run core-cms:demo --project=core-cms
  • npm run core-cms:demo --project=frontera-cms
  • npm run core-styles:demo
• Run, from root, a script of any package e.g.:
  • npm run core-cms: npm run build:css
  • npm run core-cms: npm run build:demo
  • npm run core-styles: npm run build
  • npm run core-styles: npm run start

Known Issues

1. If npm install (...) is run in a package, then core-styles package is unlinked (which can cause build errors). To restore the link, run npm ci in root.