httf v0.0.4

HTTF

This project is VERY much a work-in-progress as of right now! How about you don't use it in production? Please? Thanks!

The Hyper Text Transfer Framework.

What?

The HTTF is an API framework for Node applications built on Express, utilising eventEmmitters and modularity to create an easy to use, easily-manageable, and scalable API.

Where?

HTTF is a Node.js library built in TypeScript, so it can run anywhere you can run Node.js and Express.

When?

HTTF is a great tool for everything from microservices to load-bearing REST APIs.

If you'd like to know more before converting or adopting HTTF, drop me an email

Why?

I wanted a way to create REST APIs without all of the headaches associated with creating them, like custom creation of authentication modules and handling databases differently each time.

So I built HTTF with modularity in mind. That way you can have built-in modules, library-based modules, and your own custom modules, which all work together to create full web applications.

How?

To install, just run npm install httf.

Getting started is as simple as making a module, creating a server, and then registering the module with the server.

// module.js
const { HTTFModule } = require('httf');

const helloWorldModule = new HTTFModule({
    name: 'hello-world',
    description: 'An example Hello World module for HTTF.'
});

helloWorldModule.addRoute('GET /', (req, res) => {
    res.send('Hello, world!');
});

module.exports = helloWorldModule;

// server.js
const { HTTFClient } = require('httf');
const helloWorldModule = require('./module');

new HTTFClient();
    .registerModule(helloWorldModule);
    .start(3000);

Contributing

If you have an issue, you could create one.

If you've got something to contribute, you could fork the repo and then create a pull request to merge in your changes!

License

This software adheres to an MIT license, so you can do as you wish with the code here.

But I'd appreciate credit if you're gonna commercialise it!