Giter Club home page Giter Club logo

jai-static's Introduction

Jai Static

A simple and fast node.js module to serve static files effortlessly. Config base path and public folder path.


Twitter Follow Linkedin: Harpal Singh GitHub followers

Features

  • Easy Setup
  • Works with any framework

Installation

Install my-project with npm

  npm install jai-static

Usage / Examples

// Express
const express = require('express');
const JaiStatic = require('jai-static');

const app = express();
const port = 1111;

app.get('*', JaiStatic({
  dir: `${__dirname}/public`, // public folder
}));

app.listen(port, () => {
  console.log(`Server listening on http://localhost:${port}/ ...`);
});


//  OR Http

const http = require('http');
const JaiStatic = require('jai-static');

const server = http.createServer(async (req, res) => {
  JaiStatic({
    dir: `${__dirname}/public`, // public folder
  })(req, res, () => { /* do something after */ });
});

server.listen(1111, () => {
  console.log('Server listening on http://localhost:1111/ ...');
});

API Reference

Options

Parameter Type Description
dir string destination folder path. (Required)
basePath string base path to be used on server, default '/' (optional)

Author: @hsk11

jai-static's People

Contributors

hsk11 avatar

Stargazers

 avatar  avatar

Forkers

hsk11

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.