Giter Site home page Giter Site logo

noderestapi's Introduction

NodeRestApi

A small RESTful API built using Node.js only modules

Requirements

  • Node v8.* LTS or more
  • OpenSSL to generate HTTPS certificate

Installation

  • Clone this repository
  • create a https folder under this project: $ mkdir https
  • Go to https folder $ cd https
  • Create your HTTPS certificates with this command:

$ openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem

Starting the server

From root folder, run the following command:
Staging:

  • $ node index.js

Production:

  • $ NODE_ENV=production node index.js

Api endpoints

  • /hello: returns a welcome message (Code: 200)
  • Any other route: returns an error message (Code: 404)

Note

The code is written using ES6 conventions except for the import statements which are not fully supported yet by Node.

noderestapi's People

Contributors

ismailcherri avatar

Watchers

James Cloos avatar  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.