Giter VIP home page Giter VIP logo

apizen's Introduction

apizen

sane api with hapi

Build Status

A robust sane api application bolierplate in Node with Hapi framework. That is the idea anyway.

Modules and project organisation

  • config App configurations

  • docs Api documentation document

  • lib Application logic

    • index.js - Defines the server
    • start.js - Starts the server
    • resources - Resource modules
      • index.js - Defines the resource class, link resources to the server.
    • auth - Authentication plugin for clients
      • index.js - A wrapper to a plugin or series of plugins and schemas for authentication
      • client.js - A siulates connection to client module.
    • utils - Utils to make code more clean an testable
    • plugins - Other plugins for the app
    • models - Data modules, to work with resources
    • manifest.js: Some server configurations.
  • test Tests

    • vise - Put together files to make testing easy
    • routes - Tests for routes
    • utils - Tests for utils
    • plugins - Tests for plugins
    • server.js - Tests for the server
    • auth.js - Tests authentication
    • .foo.js - Dummy file to test lsdir
  • gulpfile.js - Defining tasks for automations. Preferebly one should run npm run watch while writing code.

  • .travis.yml - Travis CI

  • package.json, .gitignore You know what these are ๐Ÿ˜‰!

  • LICENCE current licence

Coding conventions

Adopting the conventions by hapi

API conventions

Getting inspirations from github API

More [...]

Coverage Build Status

Writting code for clarity and striving for 100% code coverage through out.

Bugs, enhancements and issues

Got some inspiration for better things or stuff doesn't work, open an issue , and let's work on it.

Contributions

Contributions are highly welcome. Fork the repo, make pull requests.

apizen's People

Contributors

rutaihwa avatar

Watchers

 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.