Skip to content

BenAbdou1001/http-server-typescript

Repository files navigation

http-server-typescript

A lightweight and efficient HTTP server written in TypeScript. This project is designed to provide a simple interface for serving HTTP requests, making it ideal for rapid prototyping, development, or learning about building servers in TypeScript.

Features

  • TypeScript-first: Built with modern TypeScript for type safety and maintainability.
  • Lightweight design: Minimal dependencies for fast startup and low resource consumption.
  • Simple API: Easy to configure and extend.
  • Shell scripts: Useful Shell scripts included for server management and automation.
  • Educational: Clean code comments and structure for learning and experimentation.

Getting Started

Prerequisites

  • Node.js (>= 14.x)
  • npm (>= 6.x)
  • [Optional] Bash-compatible shell for running management scripts

Installation

  1. Clone the repository:

    git clone https://github.com/BenAbdou1001/http-server-typescript.git
    cd http-server-typescript
  2. Install dependencies:

    npm install

Usage

Start the server

npm start

Or, if a script is provided:

./scripts/start.sh

Build the project

npm run build

Run tests

If test scripts are included:

npm test

Configuration

  • Default server port and settings can be customized in the configuration file or via environment variables. See the code and comments for details.

Contributing

Contributions are welcome! Please open issues or submit pull requests for enhancements, bug fixes, or documentation improvements.

License

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


Author: BenAbdou1001

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors