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

src-service-setup

v1.0.8

Published

Boilerplate for microservice setup

Downloads

8

Readme

src-service-setup

Overview

src-service-setup is a boilerplate tool designed to automatically create a folder structure and basic files needed for starting a microservice using Node.js and Express. This package aims to simplify the initial setup process, ensuring a well-organized directory and default configuration for quick development.

Features

  • Creates a standard folder structure for microservices:
    • src/config
    • src/controllers
    • src/middlewares
    • src/migrations
    • src/models
    • src/repository
    • src/routes/v1
    • src/seeders
    • src/services
    • src/utils
  • Automatically generates essential files with default content:
    • src/index.js
    • src/routes/index.js
    • src/routes/v1/index.js
    • src/config/ServerConfig.js
    • .env (with PORT configuration)
    • config.json (app details)

Installation

  • To install and set up the microservice boilerplate, simply run:
npm install src-service-setup

Usage

  • After running the installation command, you will find the following structure in your project:

project-directory/
├── src/
│   ├── config/
│   ├── controllers/
│   ├── middlewares/
│   ├── migrations/
│   ├── models/
│   ├── repository/
│   ├── routes/
│   │   └── v1/
│   ├── seeders/
│   ├── services/
│   └── utils/
├── .env
└── config.json
  • The basic Express server setup can be found in the src/index.js file. The server listens on the port defined in the .env file (default: PORT=3000).

  • You can extend the boilerplate by adding your controllers, services, and routes as required. The src/routes/v1/index.js file has placeholders for adding routes and linking controllers.

  • You can modify the config.json file to include application-specific configurations.

Example

  • After installation, run the following command to start the server:

node src/index.js

  • You should see the following output:

Server started on Port 3000

Dependencies

  • The package uses the following dependencies:

  • express: Web framework for Node.js

  • dotenv: Loads environment variables from .env file

  • fs-extra: Module that extends the built-in fs module with additional methods

License

  • This project is licensed under the ISC License - see the LICENSE file for details.

Author

  • Vibhanshu Kumar
  • Shivansh Tiwari