Neanderthal Painting Monet

    men-stack-starter-kit

    0.0.2 • Public • Published

    MEN (Mongodb, Express, Node) Stack Starter Kit

    This repository is the REST API Starter kit

    Requirement

    • Node
    • Express Framework
    • MongoDB (Mongoose)

    Installation

    Clone the repository:

    git clone https://github.com/NutBoltu/men-stack-starter-kit.git
    cd men-stack-starter-kit
    rm -rf .git
    

    Install mongodb globally : Official documentation

    Install dependencies using npm:

    npm install
    

    For development

    node app.js
    

    The app will run in http://localhost:1980

    For Production

    npm start
    

    Starter Kit layout

    +- config
    |   +- config.js              --> configuration file where database configuration and
    |                                 host configuration are described
    +- controllers                --> controller files
    +- models                     --> models directories that communicate with the database
    |   +- definitions            --> database models are defined
    |   +- schemas                --> mongodb schemas are described
    |   +- services               --> database access layer that connects with the db models
    |   +- db.connection.js       --> connect with mongodb
    |   +- models.js              --> initialize mongodb models
    +- node_modules               --> development dependencies node modules
    +- routes                     --> REST api routers
    +- utilities                  --> utilities files
    |   +- helpers                --> all helper files
    |   +- validator              --> api validators are described
    +- app.js                     --> application run file
    +- package.json               --> node package configuration file
    

    Licence

    MIT licence

    Install

    npm i men-stack-starter-kit

    DownloadsWeekly Downloads

    2

    Version

    0.0.2

    License

    MIT

    Last publish

    Collaborators

    • nutboltu