Skip to content

ArthurMialon/StarterApiNodejs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Framework

API Framework based on Express and Socket.io written in ECMA2015.

It give you an architecture and tools to create quickly your api (CLI, ressource manager, automatic CRUD, realtime).

This version is in development. You may not use it yet. There was an other stable version of the framework with more documentation now on the "alpha" branch.

Ideas and contributions are appreciated.

Table of Contents

Getting started

  • Clone the repo
$ cd /path/to/dir
$ npm install
$ node index.js
  • Soon the framework will be accessible from NPM with CLI

Architecture

App
|
├───api
|    └───controllers
|    |      |  base.js
|    |      |  user.js
|    |
|    └───models
|    |      |  users.js
|    |      |  index.js
|    |
|    └───config
|    |      |  app.js
|    |      |  configuration.js
|    |      |  database.js
|    |      |  
|    |      └───routes
|    |            |  users.js
|    |            |  index.js
|    |
|    └───middleware
|    |      |  auth.js
|    |      |  
|    |      └───options
|    |            |  auth.js
|    |            |  need.js
|    |            |  index.js
|    |
|    └───socket (coming soon...)

Configuration

...

Routing

...

Controllers

...

Models

...

Middleware

  • Simple

  • Options

  • Authentication ...

Socket

...

CLI

...

About

API Framework based on Express and Socket.io written in ES6.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •