Giter Club home page Giter Club logo

thekey.js's Introduction

thekey.js

TheKey.js is a TypeScript framework built on top of Fastify, which provides a database API and a standardized way of writing controllers.

The name and structure of this framework is shared with TheKey PHP version. This framework is meant as a backend API server.

  • lib/Routes.ts: Sets all routes, their callbacks, methods and middleware.
  • Controllers/: Location for all controllers, middlewares and services.
  • Classes/*: Internal classes for TheKey, provides classes such as Util, Route and Response.

Setting routes

Use Route.set to add a new route. All the callbacks are async and should return a promise.

Route.set(route, callback, methods, middleware, middlewareFail)

Middleware

The middleware callback should return the "user" object (or just true). The object returned from the callback can then be accessed from the middleware object passed in as the third argument to callback set with Route.set

Route.set("/", (req, params, middleware) => {
    return response().json(middleware.user());
}, "ALL", middleware)

Todo

  • Add a non-static/object based API for DB

thekey.js's People

Contributors

eelislynne avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.