jekyll-react-poc

This project is a simple proof of concept for using React.js alongside Jekyll.

Component source code is written in TypeScript. Sass modules are used for styling, and Jest is used for unit testing.

Requirements

• Ruby 2.6
• node 12.13.1

Note: Windows 10 users should run this project using Windows Subsystem for Linux (WSL).

Install Dependencies

bundle install

npm install

Build Components and Serve Static Site

npm run serve

This will:

1. Clean the output folders (i.e., dist and src/gen)
2. Run the UTs (for now they're fake)
3. Transpile .ts/.tsx and .scss files to the src/gen/assets folder, and populate the dist folder.
4. Serve the site locally; a demo page is accessible from localhost:4000/sample-collection/sample-article.html.

Other Scripts

• Run UTs:

  npm run test
  

• Clean all output folders:

  npm run clean
  

• Build components and static site for production:

  npm run build