
## What am I looking at? π€ This repository is our *monorepo* holding all our NPM designs, plugins, other NPM packages, and (web)sites. ## We are working on FreeSewing v3 π > We the `main` branch and `next` packages on NPM holds v3 code. But it's alpha for now. The default branch (`develop`) in this repo is where we work on the upcoming FreeSewing v3. Check out [the roadmap](https://github.com/freesewing/freesewing/discussions/1278) to see what we're working towards. There is still time to submit your ideas/suggestions for what you would like to see in our mext major release. The current production code -- what is running on freesewing.org -- is in the `v2` branch. ## Getting started β‘ As this is a monorepo. You'll need [NodeJS v16](https://nodejs.org), [lerna](https://lerna.js.org/) and [yarn](https://yarnpkg.com/) on your system. Once you have those, clone (or fork) this repo and run `yarn kickstart`: ```bash git clone git@github.com:freesewing/freesewing.git cd freesewing yarn kickstart ``` ## 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 our sewing patterns adapted to your measurements. If you're a developer, our documentation is on [freesewing.dev](https://freesewing.dev/). Our [core library](https://freesewing.dev/reference/api/) is a *batteries-included* toolbox for parametric design of sewing patterns. But we also provide a range 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 ``` Or, consult our getting started guides for [Linux](https://freesewing.dev/tutorials/getting-started-linux/), [MacOS](https://freesewing.dev/tutorials/getting-started-mac/), or [Windows](https://freesewing.dev/tutorials/getting-started-windows/). We also have a [pattern design tutorial](https://freesewing.dev/tutorials/pattern-design/) that walks you through your first parametric design, and [a friendly community](https://freesewing.org/community/where/) with people who can help you when you get stuck. ## Support FreeSewing: Become a patron π₯° FreeSewing is an open source project run by a community, and financially supported by our patrons. If you feel what we do is worthwhile, and you can spend a few coind without hardship, then you should [join us and become a patron](https://freesewing.org/community/join). ## Links π©βπ» - π» Makers website: [freesewing.org](https://freesewing.org) - π» Developers website: [freesewing.dev](https://freesewing.dev) - π¬ Chat: On Discord via [discord.freesewing.org](https://discord.freesewing.org/) - β Todo list/Kanban board: On Github via [todo.freesewing.org](https://todo.freesewing.org/) - π¦ Twitter: [@freesewing_org](https://twitter.com/freesewing_org) - π· Instagram: [@freesewing_org](https://instagram.com/freesewing_org) ## 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 π€― Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to ask questions, share your feedback, or just hang out. If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new). ## Contributors β¨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):