Giter VIP home page Giter VIP logo

coko's Introduction

coko

license dependencies Status npm npm

coko is a minimal framework built ontop of Koa.

coko provides a conventional approach for building apps using async/await pattern of Koa2. It gives a basic boiler plate for Koa ontop of which you can write your application logic.

coko is inpsired from Sailsjs and keeping the setup minimal and extensible.

Note: Check coko-bean for the example.

coko's feature includes:-

Table of contents

Get Started

Since coko is a convention over configuration framework, it uses a minimal directory structure. coko-bean is there to help you getting started with the structure that is best suited with coko.

git clone https://github.com/bhaskarmelkani/coko-bean.git

  • Go into the directory

cd coko-bean && npm install

  • Start the server

npm start

This command will run a http sever on port 4000, you can configure the port(TODO).

The seed has a test route /user

Open http://127.0.0.1:4000/user.

Whoaaa, this was quick !!!

Roadmap

coko is still developing and is ambitious to get features that should be provided by a minimal framework.

  • Add testing support.(Maybe using Jest)
  • If needed, add support for Expect: 100-continue.
  • Create a config module and provide it in controllers, services and maybe middlewares.
  • For now ejs(using koa-views) is a default templating engine, add support for configuring it.
  • Add support for static file serving.
  • Add configurable security headers for response.
  • Add better error handling.
  • Add support for customizing/adding responses(eg. res.ok(), etc...).
  • Add tracing using koa-trace.
  • Add configurable jsonp support. Check koa-safe-jsonp
  • If required add authentication strategies.
  • Add support for database handling.
  • Add cli for generating seed.
  • Asset(cs/js/image) handling.

Developement and Contributing

Check detailed contributing guidelines.

License

The MIT License (MIT). See full license.

coko's People

Contributors

bhaskarmelkani avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

coko's Issues

Use template-literal instead of EJS

Template Literal is fastest, smallest and simplest template engine, because it use JS's literal template feature.

It's 55 times faster than EJS, and it also use less CPU and RAM ressources, so it may be a good idea to use it instead of EJS ๐Ÿ˜€

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.