Code Monkey home page Code Monkey logo

node-service-starter's Introduction

node-service-starter Build Status

A thin ES6 OOP service only (non react) starter for Node.

Includes:

  • Testable organized architecture
  • Comments in every file
  • 100% Test coverage of included code (using Jest)
  • Example of versioned REST API
  • Example of handling each type of REST method (GET,POST,PATCH,PUT,DELETE)
  • Example of remote calling through use of a HTTPClient
  • HTTP and HTTPS server
  • Middleware hooks for Security, Authentication, Static Files, AppParsing, ErrorHandling

Usage

Intended as a base package for a new backend Node service.

  • Download as zip
  • Unzip into new project
  • Update package.json for new app
  • Run npm install
  • Modify!

TLS

The HTTPs server is commented out by default in the Main.js. To enable it do the following:

  • navigate to the /tls directory and run ./genSelfSigned.sh
    • This requires certstrap which can be installed through your package manager
  • Uncomment all of the lines referencing this.SecureServer in /src/Main.js
  • npm start

Playing

Can be played with directly from a git clone

  • npm install
  • npm start

Testing

npm test

Test Endpoints

(by default TLS is 9799 when enabled)

  • localhost:8799/v1/example

  • localhost:8799/v1/example/stats

  • localhost:8799/v1/example/proxy

  • localhost:8799/v1/mock/example

  • localhost:8799/v1/mock/example/stats

  • localhost:8799/v1/mock/example/proxy

node-service-starter's People

Contributors

anyuzer avatar gu3st avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.