1
0
Fork 0
freesewing/sites/dev/docs/tutorials/getting-started-mac/dev-start/readme.mdx

80 lines
2 KiB
Text
Raw Normal View History

2022-07-02 22:52:31 +02:00
---
title: Start the development environment
sidebar_position: 50
2022-07-02 22:52:31 +02:00
---
FreeSewing provides the studio, a development environment to help you design and develop patterns.
2022-07-02 22:52:31 +02:00
There are two ways to run this studio:
2022-07-02 22:52:31 +02:00
- [**Repository studio**](#repository-studio): Use this if you intend to contribute your work to FreeSewing
- [**Stand-alone studio**](#stand-alone-studio): Use this if you want to do your own thing, and not contribute to FreeSewing
2022-07-02 22:52:31 +02:00
## Repository Studio
2022-07-02 22:52:31 +02:00
Run `npm run studio` to start the repository studio development environment:
2022-07-02 22:52:31 +02:00
```bash
npm run studio
2022-07-02 22:52:31 +02:00
```
Then point your browser to http://localhost:3000
Your new design will appear in the Local Designs page.
2022-07-02 22:52:31 +02:00
:::tip
### Adding another new design
This is all you need to work on existing designs. If you'd like to add another new design, run:
2022-07-02 22:52:31 +02:00
```bash
npm run add
2022-07-02 22:52:31 +02:00
```
Just make sure to re-start the repository studio afterwards with `npm run studio`
:::
2022-07-02 22:52:31 +02:00
## Stand-alone studio
2022-07-02 22:52:31 +02:00
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.
2022-08-07 12:56:35 -07:00
You can ignore all other subfolders and files; they are part of the development environment.)
2022-07-02 22:52:31 +02:00
2022-08-07 12:56:35 -07:00
To start the development environment, enter the folder that was created
and run `npm run start`.
```bash
npm run start
```
2022-07-02 22:52:31 +02:00
Then open your browser and go to http://localhost:3000
2022-07-02 22:52:31 +02:00
:::tip
2022-07-02 22:52:31 +02:00
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.
:::
2022-07-02 22:52:31 +02:00
### Adding another new design
This is all you need to work on existing designs. If you'd like to add another new design, run:
```bash
npm run add
```
Just make sure to re-start the stand-alone studio afterwards with `npm run start`.
:::note
2022-07-02 22:52:31 +02:00
##### Yay, you're done!
2022-08-07 12:56:35 -07:00
All you have to do now is design your pattern.
2022-07-02 22:52:31 +02:00
Thankfully, we have a tutorial for that too:
- [Pattern design tutorial](/tutorials/pattern-design/): A step-by-step guide to designing your first pattern
:::