Giter VIP home page Giter VIP logo

express-mongo-example-project's Introduction

This project is an application skeleton for a typical Node.js web app.

Build Status

Getting Started

To get you started you can simply clone the repository:

git clone https://github.com/FortechRomania/express-mongo-example-project

and install the dependencies

npm install

Prerequisites

You need git to clone the repository. You can get git from http://git-scm.com/.

A number of node.js tools is necessary to initialize and test the project. You must have node.js and its package manager (npm) installed. You can get them from http://nodejs.org/. The tools/modules used in this project are listed in package.json and include express, mongodb and mongoose.

MongoDB

The project uses MongoDB as a database. If you are on Mac and using Homebrew package manager the installation is as simple as brew install mongodb.

Apidoc

To install run npm install apidoc -g.

Start the MongoDB server

First we need to create the db directory where the database files will live in. In your terminal navigate to the root of your system by doing cd .. until you reach the top directory. You can create the directory by running sudo mkdir -p /data/db. Now open a different tab in your terminal and run mongod to start the Mongo server.

Run the Application

The project is preconfigured with a simple development web server. The simplest way to start this server is:

npm start

Generate API documentation

npm run doc

The command will generate a /doc folder that will contain an index.html file. Open it in any browser. The file contains information about API routes.

Project Structure

Under Construction

express-mongo-example-project's People

Contributors

alexnm avatar danacalcaianu avatar darianrusu avatar robertbirtalan avatar snyk-bot 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.