Scaffa Documentation

Overview

Scaffa is an all-in-one collection of pre-setup frontend templates and tools designed to help you quickly start modern frontend projects.

Usage

To create a project run the command:

npx create-scaffa@latest

Then follow the interactive prompts. For more details on its implementation, check CLI Implementation.

Scaffold

You can even create a project easily with scaffold feature.

npx create-scaffa@latest <ur-project-name> -t <template> -p <package-manager>

Example

npx create-scaffa@latest scaffa-starter -t vue -p pnpm

This single line of command will create a Vue template with the name scaffa-starter and handle dependencies with pnpm. You can see the availables table in Templates.

Note that if we have option to select templates it will ask you one more question to choose option!

Templates

Each template includes routing, localization, data fetching and all others necessary things with best practices.

Project Structure

Below is an abbreviated folder structure:

 ...
 packages/
 ├── create-scaffa/
 │   ├── bin/
 │   │   └── index.js
 │   └── templates/
 src/
 static/
 ...

For a complete view, please refer to the project root.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the documentation, add features, or fix bugs.

It's really important to follow instructions of Contributing Guide.

License

This project is licensed under the MIT License.