Scribd
Upload
15 views2 pages

NPM vss-express Setup Guide

The document provides instructions for using the NPM package 'vss-express' to create a new Express project. It details the default behavior of the command 'npx vss-express create', including the creation of necessary folders and files, as well as the installation of dependencies. Additionally, it outlines various parameters that can be used to customize the project setup.

Uploaded by

victor.ss.estudos
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
15 views2 pages

NPM vss-express Setup Guide

The document provides instructions for using the NPM package 'vss-express' to create a new Express project. It details the default behavior of the command 'npx vss-express create', including the creation of necessary folders and files, as well as the installation of dependencies. Additionally, it outlines various parameters that can be used to customize the project setup.

Uploaded by

victor.ss.estudos
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

The following text is part of my project on NPM:

The full documentation is avaliable on:


[Link]

If you want to try, just run:

npx vss-express create

Execution
This behavior refers to the command without any parameters (default).

Don't worry, you can change all of this!

At the end, there's an example of what the output will look like

1. A subfolder named express will be created in the current directory.


2. A project will be initialized (creation of [Link] and addition of basic
commands).
3. The src folder will be created.
4. Express and the necessary types will be installed.
5. The [Link] file will be created, fully configured and ready to run.
6. Routing will be added.
7. Prisma and the database will be added.
8. Ensures the secure creation of a Prisma client instance.

Want more control? Here are the available


parameters
• -o [name]: Defines the name of the output folder (must be followed by the
name).
• --js: Use JavaScript instead of TypeScript.
• --no-prisma: Do not use Prisma as ORM.
• --current-dir: Specifies that the project should be created in the current folder,
without creating a new folder.
• --config: Creates a prompt to manually configure everything with a more user-
friendly interface.
• --stock: Creates a minimalist project (only express and basic app); This option
keeps TypeScript, use --js to switch.
• --no-middlewares: Creates the project without using middlewares.
• --code: Opens the project in Visual Studio Code.
• For a quick review: -h or --help

Default values
Here are the values used if the parameter is not provided:

• -o: express
• --js: OFF (use TypeScript)
• --no-prisma: OFF (use Prisma)
• --current-dir: OFF (creates a subfolder with the value of -o)
• --config: OFF
• --stock: OFF (creates the API completely)
• --no-middlewares: OFF (uses middlewares)
• --code: OFF (does not open with VSCode)

You might also like