Angular Example App

Example app with Angular 7 + Angular CLI + Angular Material + Firebase
Base project made with much ❤️ . Contains CRUD, patterns, generated library, and much more!

LIVE DEMO


Report bug · Request feature

Table of contents

• Quick start
• Status
• What's included
• Bugs and feature requests
• Contributing
• Creators
• Thanks
• Copyright and license

Quick start

Warning

Verify that you are running at least node 8.9.x and npm 5.x.x by running node -v and npm -v in a terminal/console window. Older versions produce errors, but newer versions are fine.

1. Go to project folder and install dependencies.

npm i

2. Launch development server:

npm start

Note

You don't need to build the example library because it's published in npm and added as dependency of the project.

Status

What's included

• CRUD: create, update and remove heroes with Firebase!
• Search bar, to look for heroes
• Custom loading page
• Modal and toasts (snakbar)!
• Internationalization with ng-translate and ngx-translate-extract. Also use cache busting for translation files with webpack translate loader
• Automatic translate script with Google Translate oO
• Lazy loading modules
• Service Workers
• Dynamic Imports
• Storage module (ngx-store)
• More logical structure directory (from here)
• Basic example library
• Scroll restoration and anchor examples
• Responsive layout (flex layout module)
• SASS (most common used functions and mixins) and BEM styles
• Animations!
• Angular Pipes
• Interceptors and Events (Progress bar active, if a request is pending)
• Scroll to first invalid input in forms. (ngx-scroll-to-first-invalid)
• Autocomplete enabled in forms
• Modernizr (browser features detection)
• Browser filter (Bowser) for IE ^^
• Sentry! (logs any error in the app)
• Google Tag Manager
• Unit tests with Jasmine and Karma including code coverage
• End-to-end tests with Protractor
• ES6 Promises and Observables
• Following the best practices!

Tasks	Description
npm i	Install dependencies
npm start	Start the app in development mode
npm run test	Run unit tests with karma and jasmine
npm run e2e	Run end to end tests with protractor
npm run build	Build the app for production
npm run build:library	Build the library
npm run lint	Run the linter (tslint)
npm run ci	Execute linter and tests
npm run extract	Generate all json files with the translations in assets folder
npm run translate	Translate all keys remaining using Google Translate and using English language as the origin
npm run deploy	Build the app and deploy it to firebase hosting
npm run bundle-report	Build and run webpack-bundle-analyzer over stats json
npm run release	Create a new release using standard-version
npm run docker	Build the docker image and run the container
npm run update	Update the project dependencies with ng update

Firebase

This repo is using Firebase. We use Cloud Firestore and Cloud Storage to handle CRUD operations over the heroes and to store their images.

Docker

You can build the image and run the container with Docker. The configuration is in the nginx folder if you want to change it.

docker build -t angularexampleapp .

docker run -d -p 4200:80 angularexampleapp

Travis CI

We use Travis CI to run this tasks in order:

• Linter
• Tests
• Build for production

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, all HTML and CSS should conform to the Code Guide, maintained by Ismael Ramos.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Creators

Ismael Ramos

• https://github.com/ismaestro

Thanks

Thanks to all contributors and their support:

mansya - App logo!

If you have an idea or you want to do something, tell me or just do it! I'm always happy to hear your feedback!

Copyright and license

Code and documentation copyright 2018 the authors. Code released under the MIT License.

Enjoy 🤘