Scaffold a Neutrino Project¶
Neutrino can help you quickly start new projects by scaffolding your initial
@neutrinojs/create-project uses middleware and presets
behind the scene to build projects. If you are not familiar with them, take a
moment to explore middleware and
Run the following command to start the process. Substitute
with the directory name you wish to create for this project.
❯ yarn create @neutrinojs/project <directory-name>
create command is a shorthand that helps you do two things at once.
See the Yarn create docs for
❯ npx @neutrinojs/create-project <directory-name>
@neutrinojs/create-project presently offers a scaffolding project to build an
application, a library, or components. Depending on the project type, the CLI
helper may offer different flavors of that project to scaffold. Each project
type harnesses the power of middleware or presets to configure itself.
If you wish to use a test runner,
@neutrinojs/create-project will offer to set
one up for you during the scaffolding phase.
Be sure to check out the test runner preset to get more information on its features and how files should be named.
If you wish to add linting to your project, Neutrino makes it simple to set up
during the scaffolding process.
@neutrinojs/create-project currently offers
two linting middleware choices.
@neutrinojs/create-project follows the standard
project layout specified by Neutrino.
This means that by default all project source code should live in a directory
stylesheets, images, and any other assets that would be available to import your
compiled project. Neutrino will scaffold the project with the initial
package.json, Neutrino set up, and project layout necessary to immediately start
When it comes to test runners, all project test code should live in a directory
test in the root of the project. Be sure to check out the test runner
preset to get more information on its features and how files should be named.
This project is part of the neutrino repository, a monorepo containing all resources for developing Neutrino and its core presets and middleware. Follow the contributing guide for details.