import chalk from 'chalk' import { banner } from './banner.mjs' console.clear() console.log(banner) console.log(` ${chalk.bold.yellow('๐Ÿคจ Help with our monorepo')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} Welcome to our git repository ๐Ÿ˜€ These are the most relevant folders: ๐Ÿ‘• ${chalk.green('designs/')} holds code for our designs ๐Ÿ”Œ ${chalk.green('plugins/')} holds code for our plugins ๐Ÿ“ฆ ${chalk.green('packages/')} holds code for other NPM packages ๐Ÿ”— ${chalk.green('sites/')} holds code for our various websites and APIs You can show this help at any moment by running: ${chalk.blue('yarn helpme')} ${chalk.bold.yellow('๐Ÿš€ Getting started')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} This repository relies on ${chalk.green('yarn')} workspaces. To install yarn, run this command: ${chalk.blue('npm install --global yarn')} Then, run this command in the monorepo root: ${chalk.blue('yarn kickstart')} It will install and link all dependencies, and link them together. It will also run ${chalk.blue('yarn reconfigure')} which you can run yourself at any time to (re)configure all packages and dependencies. ${chalk.bold.yellow('๐Ÿ› ๏ธ Starting the development environment')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} Our development environment for ${chalk.bold('designs')} and ${chalk.bold('plugins')} lives in ${chalk.green('sites/lab')} We refer to it as ${chalk.bold('the FreeSewing lab')}. It can display any design in this repository and will hot-reload any changes you make to a design. To start the lab, run this command: ${chalk.blue('yarn lab')} Now open your browser and navigate to ${chalk.green('http://localhost:8000/')} ${chalk.bold.yellow('๐Ÿ‘• Adding a new design')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} To add a new design to this repository, run this command: ${chalk.blue('yarn new design')} It will ask you some questions, and set everything up for you, and add your design to the lab. ${chalk.bold.yellow('๐Ÿค” More info & help')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} FreeSewing's documentation for developers and contributors is available at: ${chalk.green('https://freesewing.dev/')} Our community is on Discord. The ${chalk.bold('development-help')} channel is a good place to start: ${chalk.green('https://discord.freesewing.dev/')} Happy hacking ๐Ÿค“ `)