Serendip framework
It's a Node.js web service framework written in typescript. The main goal for creating this framework was to have a shared package that could provide all frequently used services in a specific setting which was needed for speeding up developing the rest of the Serendip platform repositories.
| Services | Description |
|---|---|
| HttpService | Http and Https server with routing system based on path-match package |
| DbService | It's a provider based, database service which currently works with MongoDb and Serendip GridDb. It also use RFC 6902(JSON Patch) to store changes on documents. |
| EmailService | Sends emails on SMTP using Nodemailer and it use Mustache to render models into html emails |
| AuthService | Authentication and group base authorization service. Implemented based on oAuth2 (RFC 6749, RFC 6750, RFC 6819) |
| Sms Services | Services for sending bulk and transactional sms |
| Fax Services | Services for sending fax (TODO) |
| ViewEngineService | Renders Mustache to HTML |
Installing
Assuming that you have already installed Nodejs, you can start installing Serendip with NPM. Open your Terminal/Command Prompt(CMD) and write:
npm install serendip --save
API Documentation
coming soon ...
Code Documentation
This documents are auto generated from typescript source using typedoc
Testing
our tests are written using mocha and u can run them by following commands. note that some of the tests need a database connection.
# Clone ( you need git installed )
git clone https://github.com/serendip-agency/serendip-framework.git
# go to downloaded directory
cd serendip-framework
# Installs npm dependencies
npm install
# running mocha tests
npm test
Related
- serendip-business-client
- serendip-business-api
- serendip-grridb-provider
- serendip-grridb-node
- serendip-grridb-controller
- serendip-mongodb-controller
- serendip-business-model
- serendip-utility
License
Collaboration, issue reporting kindly accepted.
