https://github.com/davidcralph/express-boilerplate

A cool boilerplate with a router loader and other stuff
https://github.com/davidcralph/express-boilerplate

boilerplate express express-boilerplate nodejs router-loader

Last synced: 4 months ago
JSON representation

A cool boilerplate with a router loader and other stuff

• Host: GitHub
• URL: https://github.com/davidcralph/express-boilerplate
• Owner: davidcralph
• License: mit
• Created: 2019-03-01T10:14:23.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-10-05T08:09:52.000Z (over 1 year ago)
• Last Synced: 2024-05-01T16:48:30.175Z (9 months ago)
• Topics: boilerplate, express, express-boilerplate, nodejs, router-loader
• Language: JavaScript
• Homepage:
• Size: 49.8 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# express-boilerplate

A cool boilerplate with a router loader and other stuff!

## Features

* Automatically checks ``/routers`` folder for new routers and automatically hooks them up

* Static folder where you can put your html, files etc

* Ratelimiting

* Logging (powered by [leekslazylogger](https://github.com/eartharoid/leekslazylogger))

* Config file to easily configure stuff

## Installation

1. ``git clone https://github.com/davidcralph/express-boilerplate``

2. ``npm i`` or ``yarn``

3. ``npm start`` or ``yarn start``

## Config

See ``config.json``

### Options

* Port - Port that the Express server runs on

* Static Enabled (true/false) - Whether to use the static folder or not

* Static Directory - The folder of data to serve if static is enabled