1
0
Fork 0
freesewing/sites/dev/docs/tutorials/pattern-design/part1/new-design
Benjamin Fan dcf7c0412b fix(dev): v4 tutorial setup changes (#278)
Changes to tutorial documentation:
1. Changed instances of `yarn` to `npm`. Remove references to installing `yarn`.
2. Changed instances of `@freesewing/new-design` to `@freesewing/studio`.
3. Changed instances of "lab" to "development environment" and `npm run lab` to `npm run org`.
4. Changed instances of Node v18.17.0 to v20.19.1. ~(I think I might have missed it in one spot. I'll submit a future PR for it.)~

I did not touch the Getting "Started with Vercel" and "Getting Started with Codespaces" tutorials. I need to take a closer look at these to see if they are still relevant or if we might want to remove them.

Co-authored-by: Benjamin Fan <ben-git@swinglonga.com>
Reviewed-on: https://codeberg.org/freesewing/freesewing/pulls/278
Reviewed-by: Joost De Cock <joostdecock@noreply.codeberg.org>
Co-authored-by: Benjamin Fan <benjamesben@noreply.codeberg.org>
Co-committed-by: Benjamin Fan <benjamesben@noreply.codeberg.org>
2025-05-18 09:32:33 +00:00
..
nd.png chore: Port FreeSewing.dev to docusaurus 2024-09-28 13:13:48 +02:00
readme.mdx fix(dev): v4 tutorial setup changes (#278) 2025-05-18 09:32:33 +00:00

---
title: Setting up the FreeSewing development environment
sidebar_position: 20
---

FreeSewing provides the studio, a development environment that visualizes your design for
you. This tutorial is for the stand-alone studio, not the
repository studio (which you may have set up if you followed a
getting started tutorial).

To set it up, I will open a terminal and enter the following command:

```sh
npx @freesewing/studio
```

After you enter the folder name to create, it will take a while to set
everything up. When it's done, you will have a new folder with the development
environment inside.

:::note

This will take a few minutes because the development environment has a number
of dependencies that need to be downloaded.

:::

You will have a new folder that contains the stand-alone studio development environment.
(Within this new folder, the `design` subfolder holds your design's configuration files and source code.
You can ignore all other subfolders and files; they are part of the development environment.)

### Creating a new design

If you would like to create a new design, enter the folder that was just
created and run the following command:

```bash
npm run add
```

After you've answered [some questions](#questions), it create a new
sub-folder for your design in the `designs` folder.

:::note

### Questions

#### What design name to use

Please stick to a single word name using \[a-z] to avoid problems.

#### What template to use

Use `From scratch` unless you want to start from our of our blocks:

- Use `Extend Brian` to start from [Brian](https://freesewing.eu/designs/brian)
- Use `Extend Bent` to start from [Bent](https://freesewing.eu/designs/bent)
- Use `Extend Bella` to start from [Bella](https://freesewing.eu/designs/bella)
- Use `Extend Breanna` to start from [Breanna](https://freesewing.eu/designs/breanna)
- Use `Extend Titan` to start from [Titan](https://freesewing.eu/designs/titan)

:::

### Starting the development environment

To start the development environment, enter the folder containing the
stand-alone studio and run `npm run start`.

```bash
npm run start
```

Then open your browser and go to http://localhost:3000

:::tip
The development environment will watch for any changes you make to
the pattern's source code or configuration.
When you do, the pattern will update automatically in your browser.
:::

This pattern design tutorial contains only an abbreviated overview
of the setup process.
For more detailed instructions, please refer to one of our setup tutorials:

- [Getting started on Linux](/tutorials/getting-started-linux)
- [Getting started on Mac](/tutorials/getting-started-mac)
- [Getting started on Windows](/tutorials/getting-started-windows)

:::

:::tip

##### Need help?

If you run into any issues, head over to [FreeSewing.eu/support](https://freesewing.eu/support)
which lists the various ways in which you can get help.

:::