README.md

Express seed project

This repository contains a seed project for Express server applications written in ES5/ES6. It is part of the Meanie eco system, which is a collection of boilerplate code and libraries for developing, testing and building javascript applications using the MEAN stack (MongoDB, Express, Angular and Node).

This seed project is built to work together side by side with either the Angular seed (ES5/ES6) or Angular 2 seed (TypeScript) projects for client side applications.

Installation

You can install this seed project either by manually cloning the repository, or by using the Meanie CLI, which will make the process a bit easier.

If you don't have the Meanie CLI tool installed, you can get it using:

npm install -g meanie

Using the Meanie CLI

# Seed a new Express project in the current directory
meanie seed express

# Seed a new Express project in the specified directory
meanie seed express my-project

Cloning from github

# Create empty project directory
mkdir my-project
cd my-project

# Clone repository, remove .git folder
git clone https://github.com/meanie/express-seed.git .
rm -rf .git

# Install dependencies
npm install

Running the server

Once installed, you can run the server using one of the following options:

# Start the server using node
npm start

# Start the server for development (with nodemon)
npm run dev

Look in the package.json for other scripts available to you.

Folder structure

The following is an outline of the folder structure of this seed project:

# This is where your server side Express application resides.
├─ app

# This folder contains your environment specific application config.
├─ config

# This folder is for your database migrations.
├─ migrations

# This folder contains the main run scripts for your application.
├─ scripts

# Test helpers and mocha options reside here.
└─ test

The app folder contains a mix of "route modules" (e.g. user, auth) and grouped helpers/services. The reason these are mixed is to prevent the need for excessively long relative paths for require statements (e.g. ../../../shared/services/db). Feel free to restructure as needed for your application though.

Issues & feature requests

Please report any bugs, issues, suggestions and feature requests in the meanie-express-seed issue tracker.

Contributing

Pull requests are welcome! If you would like to contribute to Meanie, please check out the Meanie contributing guidelines.

Credits

• Inspiration for this seed project came from MEAN.JS
• Meanie logo designed by Quan-Lin Sim

License

(MIT License)

Copyright 2015-2016, Adam Buczynski