Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oguzhanoya/express-mvc-boilerplate
A simple mvc boilerplate for express.js (gulp + expressjs + nodemon + browser-sync)
https://github.com/oguzhanoya/express-mvc-boilerplate
boilerplate browser-sync express express-boilerplate gulp mongodb mvc-boilerplate
Last synced: 16 days ago
JSON representation
A simple mvc boilerplate for express.js (gulp + expressjs + nodemon + browser-sync)
- Host: GitHub
- URL: https://github.com/oguzhanoya/express-mvc-boilerplate
- Owner: oguzhanoya
- License: mit
- Created: 2016-12-28T06:43:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-10-08T14:56:22.000Z (about 2 years ago)
- Last Synced: 2024-05-03T03:20:40.656Z (8 months ago)
- Topics: boilerplate, browser-sync, express, express-boilerplate, gulp, mongodb, mvc-boilerplate
- Language: JavaScript
- Homepage:
- Size: 688 KB
- Stars: 57
- Watchers: 3
- Forks: 12
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Express MVC Boilerplate
==================================
[](https://opensource.org/licenses/MIT) [](https://travis-ci.org/oguzhanoya/express-mvc-boilerplate)
> A simple mvc boilerplate for express.js (gulp + expressjs + nodemon + browser-sync)
## Related modules
* express - web application framework for node
* pug - template engine
* stylus - pre-processor CSS
* mongoose - nodejs orm for mongodb
* bower - a package manager for the web
* gulp - automate workflow
## Prerequisites
* Node.js `http://nodejs.org`
* MongoDB `brew install mongodb`
## Project Structure
```sh
.
├── app/
│ └── controllers # contains controller files
│ └── models # contains model files
│ └── views # contains express view (pug) files
│ └── routes.js # routes config file
├── config/
│ ├── index.js # environment config file
│ └── db.js # db config
├── public/ # contains static assets
│ ├── components # bower components folder
│ │ └── ...
│ ├── favicon # favicon folder
│ ├── fonts # contains font files
│ ├── css # all files will generate from gulp
│ ├── styl # contains style sheets (stylus)
│ ├── js # contains js files
│ └── img # contains image files
├── test/
│ └── spec.js # unit & func tests
├── .bowerrc # bower config
├── .bower.json # bower dependencies
├── .Procfile # process file for heroku implementation
├── .gitignore # specifies intentionally untracked files to ignore
├── .editorconfig.js # editor config
├── .gulpfile.js # gulp config
├── .eslintrc.yml # eslint config
├── .eslintignore # eslint ignore specific files and directories config file
├── .travis.yml # travis ci config
├── app.js # app setup file
└── package.json # build scripts and dependencies
```
## Getting Started
The easiest way to get started is to clone the repository:
```sh
# Get the latest snapshot
$ git clone https://github.com/oguzhanoya/express-mvc-boilerplate.git myproject
$ cd myproject
# Install dependencies
$ npm install
$ bower install
$ node app.js
```
## Development
npm run dev
Your app should now be running on [localhost:7000](http://localhost:7000/).
## Test
npm test
## Lint
npm run lint
## Docker Support
* Docker `https://docs.docker.com/engine/installation/`
```
# Build the project
docker-compose build
# Start the application
docker-compose up
```
## Deploy
Make sure you have the [Heroku Toolbelt](https://toolbelt.heroku.com/) installed.
```
heroku create
git push heroku master
heroku open
```
## License
MIT