51 lines (36 loc) · 1.57 KB

FRUI Repo Structure

The following documentation are for AI agents to help understand the underlying project structure and provide a coding style guide to use.

1. Requirements

Make sure you are using Node 22 or later.

2. Folder Structure

The following folders make up the frui repository.

components - main frui components
docs - compiled frui website (on build)
plugins - plugins used to generate the static website
public - static assets for the static website
scripts - build and development scripts
styles - frui library styles for components
tests - where test suites should go

2.1. Ignore Folders

Must ignore the following files and folders.

archives
docs
cjs
esm
node_modules

2.2. Scope of Work

Must ask for explicit permission to create, update or delete files from the following files and folders.

components
plugins
public
scripts
styles
frui.css

3. Coding Style Guides

When coding, must follow the relative code style guides.