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

z-structure-file-generator

v1.8.3

Published

CLI tool to generate folder structures

Downloads

436

Readme

Folder Structure Generator

A command-line tool to generate a standard folder structure and files for Redux Toolkit slices, update routes.tsx, and update store.ts for Redux integration.

Installation

To install the package globally, run:

npm install -g z-structure-file-generator

Prerequisites

Ensure your project directory structure is set up as follows before you start:

.
├── ...
├── src                    
│   ├── pages    
│   └── lib
│       ├── redux    
│       │   └── store.ts      # If this file doesn't exist, the package will create it
│       └── routes
│           └── routes.tsx    # If this file doesn't exist, the package will create it
└── ...

The tool will create missing files in src/lib/redux and src/lib/routes if they aren’t found.

Usage

To start the folder structure generation process,enure that you are in the src/pages then, run the following command in your terminal:

generate-structure

Step-by-Step Instructions

  1. Enter the file name: The name of the main file or component you wish to create.

  2. Enter the API endpoint: Specify the API endpoint associated with the file or component.

  3. Enter the route path: Specify the new route for this page. This will be added to routes.tsx.

Example

  1. Run the command:

    generate-structure
  2. When prompted:

    Enter the file name: userProfile
    Enter the API endpoint: /api/user/profile
    Enter the new route path: /user/profile

After completing these steps, the tool will:

  • Generate a new folder and file structure based on your input.
  • Add the necessary imports and configurations in store.ts for Redux Toolkit.
  • Update routes.tsx to include the new route.

Getting Started with Development

After the structure generation is complete, you can begin development by adding your specific content to the generated files.