Foxify

The fast, easy to use & typescript ready web framework for Node.js

Inspired by Express

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Usage
• Features
• Benchmarks
• TODO
• Versioning
• Authors
• License
• Support

Getting Started

Prerequisites

• Node.js 8 or higher is required.

Installation

npm i -s foxify

Usage

const Foxify = require('foxify');

let app = new Foxify();

app.get('/', (req, res) => {
    res.json({hello: 'world'});
});

// create an error
app.get('/error', (req, res) => {
    throw new Error('I Failed :(');
});

// create an http error
app.get('/404', (req, res) => {
    throw new HttpException('Not Found', 404);
});

app.start();

More detailed sample is available.

You can also find all the documents here.

Features

• Written in ES6
• Robust routing (faster than Express)
• Express middleware support
• Robust database modeling (Odin)
• Simple and powerful error handling
• Focus on high performance
• HTTP helpers (redirection, etc)
• View system supporting lots of template engines
• Content negotiation
• Executable for generating applications quickly

Benchmarks

Machine: Ubuntu 18.04 64-bit, Intel Core i7 (8 cores), 8GiB (DDR4)

Method: autocannon -c 100 -d 40 -p 10 localhost:3000 * 2, taking the second average

sort: R/S

TODO

• Routing
• Middleware support
• Error handling
• View engine
• Options
• Settings
• Database Model (Odin)
• Clustering
• File storage
• Job schedule
• Logging

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ardalan Amini - Owner/Developer - @ardalanamini

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Support

If my work helps you, please consider