2022-07-02 22:52:31 +02:00
|
|
|
---
|
|
|
|
title: Setting up the development environment
|
2023-09-30 14:04:18 +02:00
|
|
|
order: 20
|
2022-07-02 22:52:31 +02:00
|
|
|
---
|
|
|
|
|
2024-06-18 15:13:49 +10:00
|
|
|
FreeSewing provides a development environment that visualizes your design for
|
|
|
|
you. This tutorial is for the stand-alone development environment, not the
|
|
|
|
monorepo development environment (which you may have set up if you followed a
|
|
|
|
getting started tutorial).
|
2023-09-28 09:11:06 +02:00
|
|
|
|
|
|
|
To set it up, I will open a terminal and enter the following command:
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2022-10-04 23:36:08 +02:00
|
|
|
```sh
|
2023-09-30 15:57:51 +02:00
|
|
|
npx @freesewing/new-design
|
2022-07-02 22:52:31 +02:00
|
|
|
```
|
|
|
|
|
2023-09-30 14:04:18 +02:00
|
|
|
It will ask if it is ok to install the development environment in a new folder
|
|
|
|
named `freesewing`. You can accept the default, or pick a different folder name
|
|
|
|
if you prefer.
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-30 14:04:18 +02:00
|
|
|
It will also ask what package manager you would like to use.
|
|
|
|
Here too the default (`npm`) is fine., unless you are certain you have **yarn** installed.
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-30 14:04:18 +02:00
|
|
|
After answering these questions, files will be downloaded, dependencies installed,
|
|
|
|
and it will also initialize a git repository for you (if you have git on your system).
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2024-09-28 13:13:48 +02:00
|
|
|
:::note
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
This will take a few minutes because the development environment has a number
|
|
|
|
of dependencies that need to be downloaded.
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2024-09-28 13:13:48 +02:00
|
|
|
:::
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-30 14:04:18 +02:00
|
|
|
When it's ready, you can enter the `freesewing` directory that was just created and run `npm run dev`:
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2022-10-04 23:36:08 +02:00
|
|
|
```sh
|
2023-09-30 14:04:18 +02:00
|
|
|
cd freesewing
|
2022-07-02 22:52:31 +02:00
|
|
|
npm run dev
|
|
|
|
```
|
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
Or if you want to use yarn as package manager:
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2022-10-04 23:36:08 +02:00
|
|
|
```sh
|
2023-09-30 14:04:18 +02:00
|
|
|
cd freesewing
|
2022-08-20 18:08:01 -04:00
|
|
|
yarn dev
|
2022-07-02 22:52:31 +02:00
|
|
|
```
|
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
Now open a browser and go to http://localhost:8000
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-01-06 19:29:29 -08:00
|
|
|
If all goes well, we'll should see this landing page:
|
2022-07-02 22:52:31 +02:00
|
|
|
|
|
|
|

|
|
|
|
|
2024-09-28 13:13:48 +02:00
|
|
|
:::tip
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2024-02-29 07:55:19 -08:00
|
|
|
##### More detailed setup tutorials are available
|
|
|
|
|
|
|
|
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)
|
|
|
|
|
2024-09-28 13:13:48 +02:00
|
|
|
:::
|
2024-02-29 07:55:19 -08:00
|
|
|
|
2024-09-28 13:13:48 +02:00
|
|
|
:::tip
|
2024-02-29 07:55:19 -08:00
|
|
|
|
2023-09-30 14:04:18 +02:00
|
|
|
##### Need help?
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
If you run into any issues, head over to [FreeSewing.org/support](https://next.freesewing.org/support)
|
|
|
|
which lists the various ways in which you can get help.
|
|
|
|
|
2024-09-28 13:13:48 +02:00
|
|
|
:::
|