morse-css

Morse

CSS Framework and documentation project found at https://gcdtech.gitlab.io/morse/

Running Docusaurus

1. cd docusaurus/morse
2. (npm install)
3. npm start

Rebuilding SCSS

1. cd docusaurus/morse
2. npm run dev

Site should automatically start at http://localhost:3000/

Contributing to Morse

• The Morse team meets every 2 weeks for sprint planning
• Merge requests should be reviewed by someone else on the team.

Weekly Sprint Planning Minutes

Developing Morse React components

React components are kept in the lib folder. To develop components, you may want to test your changes in a project. NPM or Yarn's link feature can help you with this.

The following assumes the use of NPM, but will also work with Yarn.

1. Link Morse with your project

If your project depends on Morse, a symlink can be created between your checked out version of Morse and the Morse library in your project's node_modules folder.

First, register Morse with your package manager for linking.

morse$ npm link

Then complete the link in your project root

your-project$ npm link "morse-css"

2. Compile Morse

As the main file in the Morse package relies on a file being present in dist, and you want your Morse changes to appear on save, you can start the TypeScript compiler in watch mode to rebuild changes automatically.

An NPM script is provided for convenience:

morse$ npm run ts:watch

Code of Conduct

Coming soon