This document introduces Elefrant, an open source Node.js framework for building scalable APIs. It provides modularity, customizability, authentication, documentation, and other features out of the box. The creator developed it to meet his needs for building real-time, multidevice apps. The framework is currently in version 0.1 but future versions will offer more extensibility through custom components.

1. The Framework for API lovers
@elefrantjs

2. About me
Marcos Sanz Latorre
@marsanla
IT. Engineer
I’m Spanish
Denmark, USA, Poland
Love Basketball & Coding

3. About me
I quit my stable job, to follow my dream
Created 13Genius (Group of friends)
App Twitter, Elefrant, Meetk.at, Fantity

4. My Team

5. A bit of background…
We love to develop our ideas
Start Meetk.at project

6. Needs
Multidevice system - API
Modern language
Scalable

7. Technology
NodeJs :
– Fast and easy (Javascript)
– We can use for everything
– XMPP, Reverse Ajax, Websockets, Server-sent Events, Long
Polling, Flash Sockets…
– Native bindings
We want a Realtime app

8. What’s an API?
API = Application Program Interface
Set of Routines, Protocols and Tools
Used by a lot of companies

9. Benefits
Standard communications between App’s
Create App’s in the Cloud
Earn & Save Money
Multidevice
Light App’s
Fast Maintenance

10. In the market…

11. We wanted…
Just an API Framework Server
Light and Simple
Modulable

12. So…
had borned!

13. Elefrant
NodeJs Framework to create API servers
HMC
(Model & Controller modulable)
Restify based
Fast & Easy
Light
Open source

14. Features
Modulable & Customizable
Scalable + Cluster
Events
Socket, HTTP
Auto Documentation
Authentication Basic & 2.0

15. Features
Validation
Rate Limit controller
ORM Waterline
Audit & Logger
Custom Errors
Cache

16. Pros
Simple
Authentication
Documentation
Fast
Architecture
Versionable

17. Framework
Elefrant
Balancer
Websockets
http/Ajax
Cache
Db
3rd
Services
Actions
Components
Core
Pub/Sub

18. Who’s using…
Health and Nutrition Startup
Security and Biometric Software
Own projects

19. Current Version
Version 0.1
We have just started
but we have a great future

20. v 0.1 (Current)
Core
Controllers (API versions)
Models
Config
Routes
Env

21. Init
Core
Controllers (API versions)
Models
Config
Routes
Env
1 2
3
5
4
6

22. Controllers
Versions of API’s
https://api.acme.com/v1/products
https://api.acme.com/v2/products
Validation of params from path, body, query
Documentation
Functionality of the actions

23. Controllers
add: {
spec: {
summary: 'Return a list of users, filtered by parameters’,
….
},
validation: {
email: {
isRequired: true,
isEmail: true,
scope: 'body’,
description: ''
},
…
},
action: function (req, res, next) {
// Functionality
}
}

24. Models
MongoDb + ElasticSearch
Validation in Model Layer
Typical Functionality of models – like CRUD

25. Routing
Auto generate route from:
{
name: 'nameforroute',
path: 'url/of/the/route',
method: 'GET or POST or PUT or DELETE or PATCH',
version: [
'1.0.0',
’2.0.1'
],
auth: true or false,
scopes: [
'scopeItem',
'scopeItem'
],
action: api.v1.nameController.method
}

26. Config
All enviroments variables
-Config
- Env
- Production
- Database.js
- …
- Test
- …
- Development
- Database.js
- …
- Redis.js
- Database.js
- Session.js
- Logger.js
- …
module.exports = {
host: 'localhost',
port: '27017',
database: 'elefrant'
};
Access:
config.database.host

27. Integrations
Task
automator
Continuous
Integration

28. v 0.2
Core
Config Env
Actions (API versions)
Components
Default
Components

29. v 0.2
1 2 3
Core
Config Env
Actions (API versions)
Components
Default
Components
4
6
5

30. Features
+ features v 0.1
More control
Develop your own components
Open ocean of possibilities
…

31. Components
Example: oauth2.0, logger, response, audit, elasticSearch, …
Config
Components, modules or plugins
nameOfComp.js
Particles.json
Lib
Whatever you need…

32. Components
Particles.json – (Variables to define the component)
Example of component index:
module.exports = function(config, logger) {
return {
start: function() {
http.createServer(app).listen(config.server.port, function
() {
logger(‘Server listening on' +
config.server.port);
});
}
};
};
module.exports.__module = {
args: [”config", ”logger”]
};

33. Actions
Group of actions for API
Example: Users, Settings, Tweets, Favourites, …
Controllers
Models
Config
Env
Routes

34. Integrations

35. Release v. 0.2
End October 2014

36. Future features
Game server Modules
Mailer
Background Tasks
PubSub
TCP
Hooks
…

37. Real case
Client
API System
Balancer
Elefrant
MongoD
b
Cache
Redis
Elastic
search

38. Response Times
Ram: 512 MB
Processor: 1 Core
SSD: 20 GB
Tranfer: 1 Tb
Request:
Search items in mongoDb using
ElasticSearch
First call 84 ms
Next calls 4-15 ms
Con. Conex. ≤500

39. Get Started v0.1
Donwload from Github
https://github.com/Elefrant/elefrant
Install dependencies
npm install
Execute Elefrant
grunt

40. Want to get involved?
Join to Elefrant Code Team!

41. Thank you!!
@elefrantjs @marsanla
marcos.sanz@13genius.com
www.elefrant.com