Skip to content

danhnguyeen/nodejs-skeleton

Repository files navigation

Skeleton - Node.js RESTful API Build Status

Getting started

To get the Node server running locally:

  • Clone this repo
  • npm install to install all required dependencies
  • Install MongoDB Community Edition (instructions) and run it by executing mongod
  • npm start to start the local server

Code Overview

Dependencies

  • expressjs - The server for handling and routing HTTP requests
  • jsonwebtoken - For generating JWTs used by authentication
  • mongoose - For modeling and mapping MongoDB data to javascript
  • multer - For uploading files
  • babel-cli - Babel is a compiler for writing next generation JavaScript
  • eslint-config-airbnb-base - This package provides Airbnb's base JS .eslintrc as an extensible shared config

Application Structure

  • server.js - The entry point to our application.
  • app.js - This file defines our express server and connects it to MongoDB using mongoose. It also requires the routes we'll be using in the application.
  • components/ - This folder contains all the components (included routers, controllers, models).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published