Giter Club home page Giter Club logo

nodejs-express-mongoose-base's Introduction

Node.js-Express-Mongoose Base

Goal

Basic Node.js Express backend API, with MongoDB database.

Get started

  1. Prerequisites: You need to have Git, Node/npm and MongoDB installed on your computer

  2. Clone the repo

  3. Install npm dependencies (package.json)

npm install
  1. Run MongoDB in the background (in another terminal)
sudo service mongod start
  1. Run the server. It will be available at http://localhost:3000
npm run start

More details

Tech Stack

  • Node.js (v8) + Express (v4) + Mongoose (v5)
  • MongoDB database
  • Tests with Mocha & Chai
  • Linting with ESLint (Airbnb Style Guide + some custom rules)

API Available

Users

  • GET /api/users
  • POST /api/users
  • GET /api/users/:user_id
  • PUT /api/users/:user_id
  • DELETE /api/users/:user_id

Transactions

  • GET /api/transactions
  • POST /api/transactions
  • GET /api/transactions/:transaction_id

User Transactions

  • GET /api/users/:user_id/transactions

Tip: you can interact with the API with a tool like Postman

Seed Database

node db/seed.js

Run Tests

npm run test

Run Linting

npm run lint

Things missing & futur improvements

  • Authentication
  • Unit Tests
  • Use Mockgoose for tests (in-memory database)
  • REPL to interact with the database using the models

nodejs-express-mongoose-base's People

Stargazers

 avatar

Watchers

 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.