Giter Club home page Giter Club logo

node-rest-server's Introduction

node-rest-server

Secure REST API server example with Nodejs, Express, mongoose & JsonWebToken

Installing on local machine

Please make sure you have node.js installed on your machine

If you don't have, click here...

1. check if you have it installed or not,
npm -v

and,

node -v

you should see some version info in return.

2. now go to the directory where you want to place the project files using git bash (terminal for mac)
run the command

git clone URL

here URL is the http url you get from the repository page, Click here to clone

3. now navigate to the project directory with cmd (terminal for mac)
run the command

npm install

wait for it to be completed. It usually takes a minute or less to complete.
It will download all the dependencies.

4. Now run the command

npm start	

or,

node ./bin/www

It will serve the project on default port (3484).

API Documentation

Find the API documentation here.
To create your own API documentation, follow this link.

Developer Hint

Install nodemon(run on any directory, recommended for development)

npm install -g nodemon

in case of mac, you might need to mention "sudo"

Now navigate to the project directory with cmd (terminal for mac)
run the command

nodemon ./bin/www

It will serve the project and restart on any file change
It's good to remember that, ./bin/www is the entry point to the app.

Please change your editor configuration like below before you start development

Indent character: "\t" (tab)

Indent size: 2

Line endings: LF (unix)

node-rest-server's People

Contributors

tanmoythander 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.