An express wrapper with convention over configuration structure
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
src
test
.gitignore
.npmignore
LICENSE
README.md
contributors.md
jsconfig.json
package.json
seyfile.js

README.md

hex-api-server

This project is designed to serve as a backbone for node.js applications.

Quick start

Execute npm install hex-api-server --save to install hex-api-center and its dependencies into empty project directory.

Directory Structure for Projects

Directory Description
/bin/ Executable binaries
/build/ Compiled output of project
/etc/ Configuration files
/public/ Public files for web site
/src/ Project source
/src/controllers/ Controllers
/src/data/ Data Layer
/src/data/migrations/ Database migrations
/src/data/objects/ Data objects, wrappers, etc.
/src/data/providers/ Provider classes for 3rd party service integrations
/src/data/repositories/ Repository classes for gathering data from a datasource
/src/data/schemas/ Data schemas
/src/data/utils/ Utility classes for Data Layer components
/src/routing/ Routing definitions
/src/routing/filters/ Filters (e.g. mutates request to validate authentication)
/src/routing/frontControllers/ Redirects requests to internal controllers of project
/src/routing/middlewares/ Middlewares
/src/utils/ Utility classes for entire project
/test/ Project tests

Todo List

See GitHub Issues.

Dependencies

  • maester
  • express
  • spdy
  • i18n
  • swagger-jsdoc

Requirements

License

Apache 2.0, for further details, please see LICENSE file

Contributing

See contributors.md

It is publicly open for any contribution. Bugfixes, new features and extra modules are welcome.

  • To contribute to code: Fork the repo, push your changes to your fork, and submit a pull request.
  • To report a bug: If something does not work, please report it using GitHub issues.
  • To support: Donate