DozerJS

Foundational Framework for NodeJS Web Services

View project on GitHub

DozerJS Foundational Framework

Dozer is a system for rapidly developing services to support front-end applications.

It's not a framework, not a toolkit, rather Dozer aims to be a malleable and unopinionated foundation for developing RESTful API's and web services to support front-end development.

Dozer creates a core server environment using NodeJS and the Express framework then allows you to build api endpoints, database models, components and adapters which all work together to provide the services required on the front-end.

The Concept

DozerJS consists of core directories which correspond to the part of the MVC architecture and the modules which run the system

  • Core (lib, index.js, config.js) - The files which initialize and control the framework
  • Components - modules which extend functionality and are available to all controllers
  • Adapters - Modules which connect the system to other resources (primarily data sources)
  • Controllers - Handle processing of data, requests and actions within the system
  • Models - Define data structure and validation requirements
  • View (public) - Serves the client-side application which interacts with the web services

Documentation

In order to allow for the documentation to iterate with the project it is maintained in a repository. The repository also serves as a place for finding support and posing questions by submitting issues.

Read Documentation »


Getting Started

If you're looking for a quick walk-through to help you get up and running plase see the "Getting Started with DozerJS" blog post by project founder, @fluidbyte.

Quick Start

DozerJS has an npm available to make creating new instances simple. To get started install the npm globally:

npm install dozerjs -g

Then simply run the dozerjs npm via the following:

dozerjs create NewProject

Which will create the project with all neccesary assets and dependencies in the directory ./NewProject.

For more information about using the command tool please read the documentation.

If you directly clone the repository simple run npm install in the root to load dependencies, then node index.js to run the server.

The server defaults to port 8181 so when running you can naviagte to your server at port 8181 to view /public/src.

Extensions

DozerJS is created to support extensions, so if you would like to see a basic RESTful API endpoint and extension in action install the example extension by running:

dozerjs install https://github.com/DozerJS/dz-example-extension.git

via the command line client inside a DozerJS project folder root. For more information please read the documentation for the extension.