Skip to content

Commit 2764524

Browse files
IsmaestroIsmael Ramos
authored andcommitted
feat(readme): update tasks and texts
1 parent e86d251 commit 2764524

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
npm install
3434
```
3535

36-
2. Launch development server, and open `localhost:4200` in your browser:
36+
2. Launch development server:
3737
```bash
3838
npm start
3939
```
@@ -42,28 +42,28 @@
4242

4343
Tasks | Description
4444
-------------------------|---------------------------------------------------------------------------------------
45-
npm i | Installs everything needed
46-
npm start | Starts the app. Then, go to `localhost:4200`
47-
npm run test | Runs unit tests with karma and jasmine
48-
npm run e2e | Runs end to end tests
49-
npm run build | Builds the app for production
50-
npm run lint | Runs the linter (tslint)
51-
npm run ci | Executes linter and tests
52-
npm run deploy | Builds the app and deploy it to Github pages (angular-cli-ghpages) (fork to do this and remove CNAME file)
53-
npm run sme | Builds and runs source map explorer, really cool :)
54-
npm run release | Creates a new release using standard-version
55-
npm run docker | Builds the docker image and run the container
45+
npm i | Install everything needed
46+
npm start | Start the app in development mode
47+
npm run test | Run unit tests with karma and jasmine
48+
npm run e2e | Run end to end tests
49+
npm run build | Build the app for production
50+
npm run lint | Run the linter (tslint)
51+
npm run ci | Execute linter and tests
52+
npm run deploy | Build the app and deploy dist folder to Github pages (angular-cli-ghpages) (fork to do this and remove CNAME file)
53+
npm run sme | Build and run source map explorer, really cool :)
54+
npm run release | Create a new release using standard-version
55+
npm run docker | Build the docker image and run the container
5656

5757
## Features
5858

59-
* Responsive layout (flex layout module)
60-
* SASS (most common used functions and mixins) and BEM styles
61-
* Modal and toasts (snakbar)!
6259
* CRUD: create, update and remove heroes
6360
* Search bar, to look for heroes
6461
* Custom loading page
6562
* Angular Pipes
6663
* Interceptors and Events (Progress bar active, if a request is pending)
64+
* Modal and toasts (snakbar)!
65+
* Responsive layout (flex layout module)
66+
* SASS (most common used functions and mixins) and BEM styles
6767
* Internationalization
6868
* Lazy loading modules
6969
* Service Workers
@@ -93,23 +93,22 @@ This library contains a sample module, component, pipe, directive, all with test
9393

9494
You can see how to use it, or develop a new one in the repository. Any doubts, please submit an issue or make a pull request.
9595

96-
97-
9896
## Travis CI
97+
9998
We use Travis CI to run this tasks in order:
10099
* Linter
101100
* Tests
102101
* Build for production
103102
* Deploy in Github pages
104-
:)
105103

106104
## Contributing
105+
107106
- Please see the CONTRIBUTING file for guidelines.
108107
- Create **pull requests, submit bugs, suggest new features** or documentation updates :wrench:
109108

110109
## Server
111110

112-
This repo is using an API which is [a minimal app](https://github.com/Ismaestro/nodejs-example-app) in NodeJS deployed on Heroku and using PostGreSQL, to create, modify and delete heroes.
111+
This repo is using [a minimal app](https://github.com/Ismaestro/nodejs-example-app) in NodeJS deployed on Heroku and using PostGreSQL, to create, modify and delete heroes.
113112

114113
## Contributors
115114

@@ -119,6 +118,6 @@ Thanks to all contributors and their support!
119118

120119
MIT
121120

122-
Enjoy :metal:
123-
124121
I'm always happy to hear your feedback!
122+
123+
Enjoy :metal:

0 commit comments

Comments
 (0)