Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.
/ sken Public archive

StarterKit for Node.js with Express.js implementation

License

Notifications You must be signed in to change notification settings

yannamsellem/sken

Repository files navigation

README

This application is programmed in ECMAScript2015

SKEN - Starter Kit for Express and Node.js

A simple way to make a http (or https) node js app

What is this repository for?

  • Node http server
  • Express Starter Kit
  • 2.0.0

How do I get set up?

  • Just clone the project
  • Configurations are in app/configs/config.json file
  • Choose your own database use a driver (MySQL, OrientBD, MSSQL, PostgreSQL, MariaDB, SQLite and MongoDB) or create one (with init and get functions)
  • Test not implement yet
  • Implement your modules
  • Start the server with yarn start
  • Enjoy !

Hot reloading?

Use yarn run devserver for hot reloading

You already have your project setup?

Update SKEN using sh update.sh

Contribution guidelines

  • implement Jasmine for node.js unit testing
  • implement Bunyan for logging stuff
TODO:
  • Server bin
  • Server entry point (app.js, appKerner.js)
  • Write vendors classes
  • Utils classes
  • Write databases driver parent class ES6
    • MongoDB
    • Sequelize
    • MySQL
    • OrientBD
  • Import and export (ES6 versions)
  • Unit testing
  • improve Grunt implementation (broken)
  • update module: create a script to update SKEN

Who do I talk to?