NodeJS Boilerplate

This is a simple Node.js static file server project. It serves files from the public directory and includes basic security and performance features.

Features

• Serves static files from the public folder
• Handles 404 errors with a custom page
• Protects against path traversal attacks
• Only allows GET and HEAD requests
• Security headers included

Getting Started

Prerequisites

• Node.js (v18 or newer recommended)
• npm (comes with Node.js)

Installation

1. Clone or copy this project to your VM or local machine.
2. Place your static files (HTML, CSS, JS, images) in the public directory.

Usage

1. Open a terminal in the project root directory.
2. Run the startup script:

   chmod +x deploy.sh
   ./deploy.sh

   This will install dependencies and start the server in the background.
3. Access the server in your browser at:

   http://localhost:3000
   

   (or the port set in the PORT environment variable)

Manual Start

If you prefer to run the server manually:

npm install
node server.js

Customization

• Edit public/index.html for your homepage.
• Edit public/404.html for your custom 404 error page.
• Add other static files to the public directory as needed.

Logs

• Server output is written to app.log when using deploy.sh.

Security Notes

• The server restricts access to files outside the public directory.
• Only GET and HEAD requests are allowed.
• Security headers are included.

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org/