Catalog npm
PACKAGE EXPLORERView in registry

320assignment2

npm

A command-line tool to scaffold projects with customizable features.

Versions collected5
Direct dependencies0From release 1.4.0
Last observed20 Oct, 19:24 UTC

README

Current package documentation

sp25-create-320-hw2

A simple Node.js application that sets up a project with some fun features! It allows you to create files and directories based on user input, including a special unicorn feature and optional Sanrio files.

Installation

To use this package, you'll need to have Node.js installed on your machine.

  1. Clone the repository or download the files.

  2. Open a terminal in the project directory.

  3. Run the following command to install the required dependencies:

    npm install
    

    ! also make sure to change the gitignore file in the lib folder to be ".gitignore" instead of ".gitignore.txt"

Usage

Once the dependencies are installed, you can run the app by executing the following command:

npm start

The app will prompt you for the following options:

  1. Project name: Enter a name for your project directory.
  2. Super Secret Unicorn feature: Decide if you'd like to add the "Super Secret Unicorn" feature (a special file will be created if you choose "Y").
  3. README file: Decide if you'd like to include a README.md file.
  4. Sanrio data: Decide if you'd like to include Sanrio character files and data. Based on your answers, the app will create the necessary files and directories in your project folder, such as:

A project directory with the name you provided. Optionally a README.md file. Optionally Sanrio character files and directories. Optionally a "Super Secret Unicorn" feature file. Example After running npm start and answering the prompts, your project directory might look like this:

my-project/
├── README.md
├── unicorn_feature.txt (if you chose to include the unicorn)
├── sanrio/
│ ├── sanrio_characters.json
│ └── info.txt


How it works:

  • The user runs npm start, which triggers the script.
  • The user is asked a series of questions (e.g., project name, include README, etc.).
  • Based on their answers, files and directories are created in the project folder.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 5

Collected releases
VersionPublishedDirect dependenciesOpen version
1.4.0Registry latest8 Feb 20250
1.3.08 Feb 20250
1.2.08 Feb 20250
1.0.08 Feb 20250
1.1.08 Feb 20250

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:24 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:0408d232e80f875aeea7adf2c9760ebc8ae90b9cb9f1cc4c5b46f8d2247dc9ef