Development

Prerequisites

Before working on Ivy, make sure you have the following tools installed:

• Git
• Node.js (^14.17.0 or >=16.0.0)
  • (Optional) If you're on macOS, we recommend using nvm to help manage different versions of Node.js
• Yarn

Start working on Ivy locally

1. Clone this repo:

git clone https://github.com/chicostateweb/ivy.git

2. Navigate to the directory:

cd ivy

3. Install the project's dependencies:

yarn install

4. Start the dev environment:

yarn start

Then visit http//:localhost:8080 to view the site.

Documentation

The source code for the documentation site lives in the /site directory and outputs to /_site when built. The site is built with 11ty and Tailwind CSS.

Scripts

Our package.json contains a collection of run-scripts that we use to maintain, test, and build Ivy. Run yarn run <script> with any of the following values for <script>:

• start starts the local development environment (alias dev)
• dist builds the CSS and JavaScript for production and outputs to the /dist folder
• build runs dist and builds the documentation site for production
• build:preview runs a local server from the /_site folder