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

create-express-node-starter

v2.4.0

Published

CLI tool for bootstrapping Express.js projects with predefined templates

Downloads

102

Readme

create-express-node-starter

CLI tool for bootstrapping Express.js projects with a predefined template.

Author GitHub license Downloads

Overview

create-express-node-starter is a versatile CLI tool designed to streamline the process of setting up a new Express.js project with Node.js. It provides a comprehensive boilerplate with essential features such as authentication, MongoDB integration, Swagger API documentation, and more, enabling developers to kick-start their API development journey quickly and efficiently.

Features

  • Express.js Integration: Built on top of Express.js, a fast, unopinionated, minimalist web framework for Node.js.
  • MongoDB Support: Seamlessly integrates MongoDB, a popular NoSQL database, for efficient data storage and retrieval.
  • Authentication and Authorization: Includes pre-configured authentication and authorization middleware for securing endpoints.
  • Swagger API Documentation: Automatically generates API documentation using Swagger UI Express, simplifying API exploration and testing.
  • Flexible Project Structure: Follows a modular project structure that promotes scalability, maintainability, and code organization.
  • Extensible: Easily extend and customize the boilerplate to suit your specific project requirements.

Project Templates

create-express-node-starter now offers three project templates to choose from:

  • Basic Project 🌱: A basic Express.js project with Node.js and MongoDB setup.
  • Product CRUD 🚀: An Express.js project with product CRUD operations.
  • User CRUD AUTHENTIFICATION 🔒: An Express.js project with user CRUD operations and authentication (register and login).

Installation

  1. Install CLI Tool: Before using npx to create a new Express.js project, make sure to install the CLI tool globally by running:

    • For Windows:

      npm install -g create-express-node-starter
    • For macOS or Linux:

      sudo npm install -g create-express-node-starter
  2. Create a New Project: To create a new Express.js project using create-express-node-starter, run:

  • For Windows:
 npx create-express-node-starter
  • For macOS or Linux:
sudo npx create-express-node-starter
  1. Follow the Prompts: The CLI tool will guide you through the process of setting up your new project, allowing you to customize various options such as project name, description, author, and more.

Getting Started

  1. Navigate to Project Directory: After creating your new Express.js project, navigate to the project directory using the following command:
cd <project-name>
  1. Install Dependencies: Install the project dependencies by running:
npm install
  1. Configure Environment Variables: copy the .env.example file to .env and update the environment variables as needed.

  2. Start Development: Navigate to your project directory and run the following command to start the development server:

  • For Windows:
    npm run develop
  • For macOS or Linux:
    npm run develop:mac
  1. Explore API Documentation: Access the Swagger API documentation at http://localhost:5000/api-docs to explore and test your API endpoints.

  2. Generate CRUD Operations: After running the project, you can create CRUD operations using the following command:

   npm run crud:operation

This command will create controllers, routes, and models for your CRUD operations. Choose between empty and minimal templates or remove existing CRUD components.

Contributing

Contributions are welcome! If you have suggestions, feature requests, or bug reports, please open an issue on the GitHub repository. Pull requests are also encouraged. Please read the CONTRIBUTING.md file for more details.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Sponsor on Buy Me a Coffee

If you find this project valuable, consider supporting us through Buy Me a Coffee. Your sponsorship helps us maintain and improve the project, ensuring better features, updates, and support for the community.