2022-07-02 22:52:31 +02:00
|
|
|
---
|
|
|
|
title: Setting up the development environment
|
|
|
|
order: 100
|
|
|
|
---
|
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
FreeSewing provides a development environment that visualizes your design for you.
|
|
|
|
|
|
|
|
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
|
2022-10-09 23:47:32 +02:00
|
|
|
npx @freesewing/new-design@next
|
2022-07-02 22:52:31 +02:00
|
|
|
```
|
2022-10-09 23:47:32 +02:00
|
|
|
<Fixme compact>Remove `@next` suffix once v3 is in production</Fixme>
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
It will ask some questions.
|
2022-10-09 23:47:32 +02:00
|
|
|
All the defaults will do, but here are the details:
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2022-10-09 23:47:32 +02:00
|
|
|
- *What template would you like to use?* — Pick the default: **Tutorial**
|
|
|
|
- *What package manager should we use?* — Pick the default: **npm**, unless you are certain you have **yarn** installed
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
After answering these questions, files will be copied, dependencies installed, and requirements downloaded.
|
2022-07-02 22:52:31 +02:00
|
|
|
|
|
|
|
<Note>
|
|
|
|
|
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
|
|
|
|
|
|
|
</Note>
|
|
|
|
|
2023-09-28 09:11:06 +02:00
|
|
|
When it's ready, you can enter the `tutorial` 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
|
2022-10-09 23:47:32 +02:00
|
|
|
cd tutorial
|
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
|
2022-10-09 23:47:32 +02:00
|
|
|
cd tutorial
|
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
|
|
|
|
|
|
|

|
|
|
|
|
2022-10-09 23:47:32 +02:00
|
|
|
## Notes
|
2022-07-02 22:52:31 +02:00
|
|
|
|
2022-10-09 23:47:32 +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.
|
|
|
|
|