npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

perfect-node-structure

v1.0.3

Published

A Node.js project structure generator

Downloads

275

Readme

Express.js Project Structure Generator

This Node.js script automatically generates a standardized folder structure for an Express.js project. It creates a src directory with essential subdirectories and files commonly used in Express.js applications.

Folder Structure

The script creates the following folder structure:

src/
├── server.js
├── middlewares/
│   ├── joi.validate.js
│   ├── uploads.js
│   └── auth.js
├── config/
│   └── db.config.js
├── routes/
│   └── user.routes.js
├── models/
│   └── user.model.js
├── controllers/
│   └── user/
│       ├── signup.controller.js
│       └── login.controller.js
└── utils/

Usage

  1. Save the script as index.js in your project directory.
  2. Make the script executable:
    chmod +x index.js
  3. Run the script:
    ./index.js

Functionality

  • The script creates the main src directory if it doesn't exist.
  • It then creates subdirectories for middlewares, config, routes, models, controllers, and utils.
  • Specific files are created in each subdirectory as needed.
  • The script checks for existing folders and files to avoid overwriting.
  • Console output provides information about created folders and files.

Customization

You can easily modify the subFolders array and the createFolderStructure function to adjust the folder structure and files created according to your project needs.

Note

The script changes the current working directory to two levels up before creating the folder structure. Ensure you run it from the appropriate location in your project.

Dependencies

This script uses Node.js built-in modules:

  • fs for file system operations
  • path for handling file paths

No additional dependencies are required.

License

This script is provided as-is under the MIT License. Feel free to modify and use it in your projects.