This project serves as the boilerplate for an application using the MEAN stack. I hope to use it for my own personal angular projects, but I think it's also a good start for others looking to introduce themselves to MEAN.
This project takes the result of the Tour Of Heroes angular tutorial and extends it to use Express, Mongo DB, Node.js, Auth0 for Authentication and Heroku for deploying builds. This should make this project a great starting point for developers just getting started with angular.
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.
Using angular dev server
// Mongo db should be installed and started.
> npm install
> npm start
> npm start-ng
// Navigate to http://localhost:4200/
Using an Express server with generated static content
// Mongo db should be installed and started.
> npm install
> npm build
> npm start
// Navigate to http://localhost:4040/
With Docker
> docker-compose up
// Navigate to http://localhost:4200/
This project was generated with Angular CLI version 6.0.0.
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.
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.
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.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.
- 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
- Default db is named
mean - Default port is
27017 - Configuration can be updated in
.env
- To start a dockerized version of your application, use
docker-compose up
- This project uses Auth0 for authentication.
- This project is configured to deploy on Heroku.
- Latest version can be viewed at this URL https://mean-hero.herokuapp.com/heroes. This may take up to a minute to start up as the app server sleeps after 30 minutes of inactivity
To make this project a little bit more exciting, I have added the ability to load the database with heroes from Heroes of the Storm. An export of hero data from the game can be generated using this project. The output JSON can be passed as the body for the service localhost:4040/heroes/bulkimport