Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nutboltu/men-stack-starter-kit
This repository is the starter kit of men (mongo, express, node ) stack REST api
https://github.com/nutboltu/men-stack-starter-kit
express men mongodb nodejs starter-kit
Last synced: 2 months ago
JSON representation
This repository is the starter kit of men (mongo, express, node ) stack REST api
- Host: GitHub
- URL: https://github.com/nutboltu/men-stack-starter-kit
- Owner: nutboltu
- Created: 2016-08-21T12:33:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-19T17:16:23.000Z (about 8 years ago)
- Last Synced: 2024-10-06T03:13:15.212Z (3 months ago)
- Topics: express, men, mongodb, nodejs, starter-kit
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://docs.mongodb.com/manual/installation)
Install dependencies using npm:
```
npm install
```
### For development
```
npm run dev
```
The app will run in http://localhost:3000
### For Production
```
npm start
```
### Starter Kit layout
```
+- config
| +- index.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
| +- handlers --> 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
| +- validators --> api validators are described
+- server.js --> application run file
+- package.json --> node package configuration file
```
## Licence
MIT licence