Flamekit 🔥 NPM Package

A simple NPM package for quickly setting up an Express server with customizable middleware and routes.

Features

• Easy setup of an Express server
• Built-in support for middleware like Helmet for security
• Extensible with user-defined middleware and routes
• Graceful shutdown handling

Installation

To install the package, use npm:

npm install flamekit

Usage

Import the Client Class:

import { Client } from 'flamekit';

Create a New Client Instance:

You need to provide the configuration for your server:

const client = new Client({
  NODE_ENV: 'development',
  HOST: 'localhost',
  PORT: 3000
});

Add Middleware:

You can add custom middleware using the use method:

client.use((req, res, next) => {
  console.log('Custom middleware executed');
  next();
});

Add Routes:

Define your routes using the addRoutes method:

client.addRoutes({
  '/hello': (req, res) => {
    res.send('Hello World!');
  },
  '/goodbye': (req, res) => {
    res.send('Goodbye World!');
  }
});

Start the Server:

Finally, start the server:

client.startServer();

Complete Example

Here is a complete example demonstrating how to use the package:

import { Client } from 'flamekit';
import express from 'express';

const client = new Client({
  NODE_ENV: 'development',
  HOST: 'localhost',
  PORT: 3000
});

// Adding custom middleware
client.use((req, res, next) => {
  console.log('Custom middleware executed');
  next();
});

// Adding custom routes
client.addRoutes({
  '/hello': (req, res) => {
    res.send('Hello World!');
  },
  '/goodbye': (req, res) => {
    res.send('Goodbye World!');
  }
});

// Starting the server
client.startServer();

Error Handling

You can also define a custom error handler:

client.useErrorHandler((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('Something broke!');
});

License

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

Contributing

If you have suggestions for improving this package, please create an issue or submit a pull request.

Notes:

• Replace flamekit with the actual name of your package.
• Make sure to include a LICENSE file in your repository if you mention it in the README.
• Adjust the features, installation, usage, and contributing sections according to any additional features or instructions you may want to add to your package.

This README provides a solid starting point for users to understand how to use your NPM package effectively!