VSinerva/freesewing
1
0
Fork 0
Code Activity

feat(markdown): Ported code howtos to v3

Browse source
This commit is contained in:
Joost De Cock 2022-10-12 14:42:45 +02:00
parent d1edf93750
commit af99d3e8c0
25 changed files with 451 additions and 636 deletions
Download patch file Download diff file Expand all files Collapse all files

53
markdown/dev/howtos/code/create-new-design/en.md
View file

@ -4,39 +4,40 @@ for: developers
about: Shows you how to create a new design
---
To create a new pattern, call `new freesewing.Design()`.
It takes your pattern configuration,
and any plugins you want to load as parameters.
When creating a new design, you have two options:
For example, if we were creating a new pattern called `Sorcha`:
- Create it in a stand-along development environment
- Create it inside (your fork of ) the FreeSewing monorepo
```js
import freesewing from "@freesewing/core"
import plugins from "@freesewing/plugin-bundle"
import config from "../config"
If you are unsure what to pick, go with the standalong development environment.
It is the best choice for people new to FreeSewing.
// Create new design
const Sorcha = new freesewing.Design(config, plugins)
Working inside the monorepo is the preferred way of regular contributors, but
if you were a regular contributor, you would probably already know this. So
when in doubt, go stand-alone. You can always change track later.
## Stand-alone
To setup the standalong development environment, you need NodeJS 16 or higher.
Then run:
```sh
npx @freesewing/new-design@next
```
This method does not return a `Design` object. Instead it returns
a constructor method for your pattern.
This command will setup FreeSewing's stand-alone development environment.
When importing your pattern, it is itself a constructor:
## Work inside the monorepo
```js
import Sorcha from "@freesewing/sorcha"
First, [fork our monorepo](https://github.com/freesewing/freesewing/fork). Then run:
// Sorcha is a constructor for your pattern.
let pattern = new Sorcha()
```sh
git clone <url to your fork>
cd freesewing
yarn kickstart
yarn new design
```
<Tip>
##### Design() is a super-constructor
Constructors are functions you can call with `new` to create an object.
As `freesewing.Design()` returns a constructor, you can think of it
as a super-constructor.
</Tip>
These commands will clone your fork of the
[freesewing/freesewing](https://github.com/freesewing/freesewing) repository on
Github and set it up for development.