chore: Updated tutorial for v3
This commit is contained in:
parent
b5e1554e4f
commit
3bc5fe28de
47 changed files with 2635 additions and 1526 deletions
|
@ -1,45 +1,32 @@
|
|||
---
|
||||
title: Files and folder structure
|
||||
order: 110
|
||||
title: Folder structure
|
||||
order: 40
|
||||
---
|
||||
|
||||
Inside our `tutorial` folder, the `design/src` folder holds the source code for
|
||||
the new pattern we will create.
|
||||
Inside the `freesewing` folder -- which might have a different name if that is
|
||||
the choice you made -- you will find a bunch of files and folders.
|
||||
|
||||
If you want to support internationalization in your design, your translations
|
||||
go in the `design/i18n` folder.
|
||||
The one that matter is the `design` folder. In it, you will find the followin
|
||||
subfolders:
|
||||
|
||||
We can safely ignore all other files and folders, as they are part of the
|
||||
FreeSewing development environment.
|
||||
So feel free to skip ahead to [Our first part](/tutorials/pattern-design/our-first-part).
|
||||
- `from-bella`
|
||||
- `from-bent`
|
||||
- `from-breanna`
|
||||
- `from-brian`
|
||||
- `from-scratch`
|
||||
- `from-titan`
|
||||
- `tutorial`
|
||||
|
||||
## Notes
|
||||
Remember when you click the **Design** icon in the header it would bring up
|
||||
this menu:
|
||||
|
||||
If you'd like to learn about those other files and folders, here's what they do:
|
||||

|
||||
|
||||
### folders
|
||||
As you might have guessed by now, each of these options is contained in its
|
||||
own subfolder under `designs`.
|
||||
|
||||
- `design`: Holds the source code for our design
|
||||
- `lab`: Holds [React][react] hooks and components specific to the development environment
|
||||
- `node_modules`: Holds installed dependencies
|
||||
- `pages`: Holds [NextJS][next] client-side routes, aka pages
|
||||
- `public`: Holds pre-generated translation files
|
||||
- `shared`: Holds files from FreeSewing's shared codebase for frontend development
|
||||
You can edit the files under `designs/[template]/src/` and the changes you make
|
||||
will be reflected in the development environment.
|
||||
|
||||
### files
|
||||
|
||||
- `next.config.mjs`: The [NextJS][next] configuration file
|
||||
- `next-i18next.config.js`: The configuration file for [next-i18next][i18n] which handles translation within NextJS
|
||||
- `package.json`: Every Node.js project has a [package.json][pkg] file which holds important metadata and lists dependencies
|
||||
- `package-lock.json`: This *lockfile* will only exist if we use the npm package manager
|
||||
- `postcss.config.js`: Configuration file for [PostCSS][postcss], a tool to transform CSS with JavaScript
|
||||
- `tailwind.config.js`: Configuration file for the [TailwindCSS][tailwind] framework
|
||||
- `yarn.lock`: This *lockfile* will only exist if we use [the yarn package manager][yarn]
|
||||
|
||||
[next]: https://nextjs.org/
|
||||
[tailwind]: https://tailwindcss.com/
|
||||
[postcss]: https://postcss.org/
|
||||
[yarn]: https://yarnpkg.com/
|
||||
[pkg]: https://docs.npmjs.com/cli/v8/configuring-npm/package-json
|
||||
[react]: https://reactjs.org/
|
||||
[i18n]: https://next.i18next.com
|
||||
Don't take my word for it though. Let's start doing exactly that
|
||||
in [Part 2](/tutorials/pattern-design/part2).
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 217 KiB |
Loading…
Add table
Add a link
Reference in a new issue