/mean-octotrails-starter

Boilerplate for creating osoc18/octotrails using the MEAN.io stack

Primary LanguageTypeScriptMIT LicenseMIT

MEAN Octotrails Starter

Overview

This project serves as the boilerplate for an oSoc18 project using the MEAN stack.

Much of the project design comes from mean.io. However, it is using Angular version 6, and the latest version of all MEAN dependencies. The ability to use the ng-cli should make extending this boilerplate significantly easier.

How to start

// Install mongo db 
> npm install
> npm start
// Navigate to http://localhost:4200/

Or with Docker

> docker-compose up
// Navigate to http://localhost:4200/

Angular

This project was generated with Angular CLI version 6.0.0.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

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

Express

  • Express server can be started with node src/server-start.js
  • Once the angular project has been built, it will be hosted automatically by express
  • The heroes API can be found at http://localhost:4040/api/heroes

Mongo DB

  • Default db is named mean
  • Default port is 27017
  • Configuration can be updated in .env

Docker

  • To start a dockerized version of your application, use docker-compose up