This project is outdated, please checkout the new mean-start-2, full stack Angular + Nest, based on ngx-admin template.

MEAN Start

Angular + Angular CLI + Express + Mongoose + Socket.IO. All in TypeScript.

DEMO

Prerequisites

Install global dependencies:

npm install -g typescript
npm install -g @angular/cli

Create a new project based on the MEAN Start

Clone this repo into new project folder (e.g., my-proj):

git clone https://github.com/cj-wang/mean-start my-proj
cd my-proj

Install npm packages

Install the npm packages described in the package.json:

yarn

or alternatively:

npm install

Development server

Start the dev server:

npm run dev

Navigate to http://localhost:4200/ for the app. Shut it down manually with Ctrl-C.

The npm run dev script starts 2 servers concurrently:

angular-cli dev server - starts at http://localhost:4200/, serving the angular app. The angular app will automatically reload if you change any of the client source files.
express server - starts at http://localhost:3000/, serving the REST APIs. The express server will be automatically restarted by nodemon if you change any of the server source files.

The angular-cli dev server is configured to proxy all API calls to http://localhost:4200/api to go to the express server http://localhost:3000/api, so that the whole app is available at http://localhost:4200/.

You're ready to write your application.

Develop

Model class

Add mongoose model classes in server/models/ directory, e.g. server/models/user.ts:

import * as mongoose from 'mongoose';

export interface IUser {
  email: string;
  password: string;
  name: string;
};

const userSchema = new mongoose.Schema({
  email: String,
  password: String,
  name: String
});

interface IUserModel extends IUser, mongoose.Document { }

const User = mongoose.model<IUserModel>('User', userSchema);

export default User;

Model classes in server/models/ directory are exposed as REST APIs by default. E.g. with the User model added, below REST APIs are created automatically:

POST /api/users - Create a User
GET /api/users - Get all the users
GET /api/users/:user_id - Get a single user
PUT /api/users/:user_id - Update a user with new info
DELETE /api/users/:user_id - Delete a user

TODO: Role-based access control required.

Custom API

Add API modules in server/routes/api/ directory, e.g. server/routes/api/demo/test.ts:

import { Router, Request, Response } from 'express';

export default Router()
  .get('/test', testHandler);

export function testHandler(req: Request, res: Response) {
  res.send('Test API works');
};

All the API modules must have a default export of type express.Router. They will be imported by app.ts and be added to the express app automatically. The root of the Routers correspond to the sub directories starting from api/, so the path of above API is /api/demo/test.

The handler functions should also be exported for unit testing.

TODO: Role-based access control required.

Socket.IO

Add Socket.IO modules in server/socket.io/ directory, e.g. server/socket.io/chat.ts:

import * as sio from 'socket.io';

const chatServer = sio({
  path: '/socket.io/chat'
});

chatServer.on('connection', (socket) => {
  console.log('a user connected');
  socket.on('chat message', (msg) => {
    console.log('message: ' + msg);
    chatServer.emit('chat message', msg);
  });
  socket.on('disconnect', () => {
    console.log('user disconnected');
  });
});

export default chatServer;

All the Socket.IO modules must have a default export of type SocketIO.Server. They will be imported by www.ts and be attached to the express server automatically.

Angular Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.

Build

npm run build

The server compiled files will be stored in the dist/ directory. The client build artifacts will be stored in the dist/public/ directory. The dist/ directory is the full distribution of the app.

Running unit tests

Run npm test to execute the unit tests for both the Angular app and the server app concurrently. You can also run npm run test-ng or npm run test-server to test the Angular app or the server app separately.

Running server API integration tests

Run npm run test-api to execute the server API integration tests.

API integration test files must be named as *.api.spec.ts to be separated from unit test files.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

Deploying to AWS Elastic Beanstalk

Prerequisites:

Deploy the app to Elastic Beanstalk:

eb init --platform node.js --region us-west-2
eb create --instance_type t2.small --sample node-express-env
eb deploy

To view your application in the web browser run:

eb open

Deploying to Google App Engine

Prerequisites:

Deploy the app to the App Engine flexible environment:

gcloud app deploy

To view your application in the web browser run:

gcloud app browse

Deploying to Heroku

Prerequisites:

Commit your changes to git, then deploy your app to Heroku:

heroku create
git push heroku master

To open the app in your browser, type:

heroku open

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

cj-wang/mean-start

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Packages