Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1.47 KB

README.md

File metadata and controls

21 lines (12 loc) · 1.47 KB
Raw

FAC Curriculum

This repo contains the source code and content for our open-source curriculum: learn.foundersandcoders.com.

To learn more about the curriculum, including whether you're allowed to use it, please read the curriculum's about page.

Running locally

This site is built using the Eleventy static site generator. It requires Git, Node and npm installed on your machine to start.

  1. Clone this repo
  2. Run npm install to install all the required dependencies
  3. Run npm run dev to start an auto-reloading development server

Alternatively run npm run build to create the final production _site directory. You can serve this with any web server as it's static HTML, CSS and JS.

Git hooks

This package installs a custom pre-commit Git hook when you npm install. This hook automatically formats your changes using Prettier (with the default settings). This ensures all files have consistent style and formatting. So don't be surprised if you see things move around a bit after you commit a change.

Remark and Alex are set up to run on every commit. These will check for markdown formatting, and for inclusive language respectively. If ever you get stuck with a word not being accepted that should be, you can add the rule to the .alexrc.js file.