2023-06-01 18:28:22 +02:00
|
|
|

|
|
|
|
<p align='center'><a
|
|
|
|
href="https://www.npmjs.com/package/@freesewing/react-components"
|
|
|
|
title="@freesewing/react-components on NPM"
|
|
|
|
><img src="https://img.shields.io/npm/v/@freesewing/react-components.svg"
|
|
|
|
alt="@freesewing/react-components on NPM"/>
|
|
|
|
</a><a
|
|
|
|
href="https://opensource.org/licenses/MIT"
|
|
|
|
title="License: MIT"
|
|
|
|
><img src="https://img.shields.io/npm/l/@freesewing/react-components.svg?label=License"
|
|
|
|
alt="License: MIT"/>
|
|
|
|
</a><a
|
|
|
|
href="https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256"
|
|
|
|
title="Code quality on DeepScan"
|
|
|
|
><img src="https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg"
|
|
|
|
alt="Code quality on DeepScan"/>
|
|
|
|
</a><a
|
|
|
|
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Areact-components"
|
|
|
|
title="Open issues tagged pkg:react-components"
|
|
|
|
><img src="https://img.shields.io/github/issues/freesewing/freesewing/pkg:react-components.svg?label=Issues"
|
|
|
|
alt="Open issues tagged pkg:react-components"/>
|
|
|
|
</a><a
|
|
|
|
href="#contributors-"
|
|
|
|
title="All Contributors"
|
2023-12-03 17:34:44 +01:00
|
|
|
><img src="https://img.shields.io/badge/all_contributors-119-pink.svg"
|
2023-06-01 18:28:22 +02:00
|
|
|
alt="All Contributors"/>
|
|
|
|
</a></p><p align='center'><a
|
|
|
|
href="https://twitter.com/freesewing_org"
|
|
|
|
title="Follow @freesewing_org on Twitter"
|
|
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
|
|
|
|
alt="Follow @freesewing_org on Twitter"/>
|
|
|
|
</a><a
|
|
|
|
href="https://chat.freesewing.org"
|
|
|
|
title="Chat with us on Discord"
|
|
|
|
><img src="https://img.shields.io/discord/698854858052075530?label=Chat%20on%20Discord"
|
|
|
|
alt="Chat with us on Discord"/>
|
|
|
|
</a><a
|
|
|
|
href="https://freesewing.org/patrons/join"
|
|
|
|
title="Become a FreeSewing Patron"
|
|
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
|
|
|
|
alt="Become a FreeSewing Patron"/>
|
|
|
|
</a><a
|
|
|
|
href="https://instagram.com/freesewing_org"
|
|
|
|
title="Follow @freesewing_org on Twitter"
|
|
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
|
|
|
|
alt="Follow @freesewing_org on Twitter"/>
|
|
|
|
</a></p>
|
|
|
|
|
|
|
|
# @freesewing/react-components
|
|
|
|
|
|
|
|
React components by/for FreeSewing
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## What am I looking at? 🤔
|
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
This repository is the FreeSewing *monorepo* holding all FreeSewing's websites, documentation, designs, plugins, and other NPM packages.
|
2023-06-01 18:28:22 +02:00
|
|
|
|
|
|
|
This folder holds: @freesewing/react-components
|
|
|
|
|
|
|
|
If you're not entirely sure what to do or how to start, type this command:
|
|
|
|
|
|
|
|
```
|
|
|
|
npm run tips
|
|
|
|
```
|
|
|
|
|
|
|
|
> If you don't want to set up a dev environment, you can run it in your browser:
|
|
|
|
>
|
|
|
|
> [](https://gitpod.io/#https://github.com/freesewing/freesewing)
|
|
|
|
>
|
|
|
|
> We recommend that you fork our repository and then
|
|
|
|
> put `gitpod.io/#<entire-url-of-your-fork` into a browser
|
|
|
|
> to start up a browser-based dev environment of your own.
|
|
|
|
|
|
|
|
## About FreeSewing 💀
|
|
|
|
|
|
|
|
Where the world of makers and developers collide, that's where you'll find FreeSewing.
|
|
|
|
|
|
|
|
If you're a maker, checkout [freesewing.org](https://freesewing.org/) where you can generate
|
2023-09-30 17:40:53 +02:00
|
|
|
sewing patterns adapted to your measurements.
|
2023-06-01 18:28:22 +02:00
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
If you're a developer, the FreeSewing documentation lives at [freesewing.dev](https://freesewing.dev/).
|
|
|
|
The FreeSewing [core library](https://freesewing.dev/reference/api/) is a *batteries-included* toolbox
|
|
|
|
for parametric design of sewing patterns. But FreeSewing also provides a range
|
2023-06-01 18:28:22 +02:00
|
|
|
of [plugins](https://freesewing.dev/reference/plugins/) that further extend the
|
|
|
|
functionality of the platform.
|
|
|
|
|
|
|
|
If you have NodeJS installed, you can try it right now by running:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
npx create-freesewing-pattern
|
|
|
|
```
|
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
Getting started guides are available for:
|
|
|
|
- [Linux](https://freesewing.dev/tutorials/getting-started-linux/)
|
|
|
|
- [MacOS](https://freesewing.dev/tutorials/getting-started-mac/)
|
|
|
|
- [Windows](https://freesewing.dev/tutorials/getting-started-windows/)
|
2023-06-01 18:28:22 +02:00
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
The [pattern design tutorial](https://freesewing.dev/tutorials/pattern-design/) will
|
|
|
|
show you how to create your first parametric design.
|
2023-06-01 18:28:22 +02:00
|
|
|
|
|
|
|
## Support FreeSewing: Become a patron 🥰
|
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
FreeSewing is an open source project maintained by Joost De Cock and financially supported by the FreeSewing patrons.
|
2023-06-01 18:28:22 +02:00
|
|
|
|
2023-11-03 19:41:41 +01:00
|
|
|
If you feel FreeSewing is worthwhile, and you can spend a few coins without
|
2023-06-01 18:28:22 +02:00
|
|
|
hardship, then you should [join us and become a patron](https://freesewing.org/community/join).
|
|
|
|
|
|
|
|
## Links 👩💻
|
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
**Official channels**
|
|
|
|
|
|
|
|
- 💻 Makers website: [FreeSewing.org](https://freesewing.org)
|
|
|
|
- 💻 Developers website: [FreeSewing.dev](https://freesewing.dev)
|
|
|
|
- ✅ [Support](https://github.com/freesewing/freesewing/issues/new/choose),
|
|
|
|
[Issues](https://github.com/freesewing/freesewing/issues) &
|
|
|
|
[Discussions](https://github.com/freesewing/freesewing/discussions) on
|
|
|
|
[GitHub](https://github.com/freesewing/freesewing)
|
|
|
|
|
|
|
|
**Social media**
|
|
|
|
|
2023-06-01 18:28:22 +02:00
|
|
|
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
|
|
|
|
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)
|
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
**Places the FreeSewing community hangs out**
|
|
|
|
|
|
|
|
- 💬 [Discord](https://discord.freesewing.org/)
|
|
|
|
- 💬 [Facebook](https://www.facebook.com/groups/627769821272714/)
|
|
|
|
- 💬 [Reddit](https://www.reddit.com/r/freesewing/)
|
|
|
|
|
2023-06-01 18:28:22 +02:00
|
|
|
## License: MIT 🤓
|
|
|
|
|
|
|
|
© [Joost De Cock](https://github.com/joostdecock).
|
|
|
|
See [the license file](https://github.com/freesewing/freesewing/blob/develop/LICENSE) for details.
|
|
|
|
|
|
|
|
## Where to get help 🤯
|
|
|
|
|
2023-09-30 17:40:53 +02:00
|
|
|
For [Support](https://github.com/freesewing/freesewing/issues/new/choose),
|
|
|
|
please use the [Issues](https://github.com/freesewing/freesewing/issues) &
|
|
|
|
[Discussions](https://github.com/freesewing/freesewing/discussions) on
|
|
|
|
[GitHub](https://github.com/freesewing/freesewing).
|
2023-06-01 18:28:22 +02:00
|
|
|
|