Skip to content
This repository was archived by the owner on Aug 30, 2021. It is now read-only.

Commit 39e4282

Browse files
committed
updating README file with more elaborate instructions on running grunt in different environment modes (dev/prod/secure ssl)
updating title for the SSL section and added information about the port number in secure environment mode
1 parent 9e8ee9e commit 39e4282

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -73,29 +73,51 @@ After the install process is over, you'll be able to run your application using
7373
$ grunt
7474
```
7575

76-
Your application should run on port 3000, so in your browser just go to [http://localhost:3000](http://localhost:3000)
76+
Your application should run on port 3000 with the *development* environment configuration, so in your browser just go to [http://localhost:3000](http://localhost:3000)
7777

7878
That's it! Your application should be running. To proceed with your development, check the other sections in this documentation.
7979
If you encounter any problems, try the Troubleshooting section.
8080

81+
* explore ```config/env/development.js``` for development environment configuration options
82+
83+
### Running in Production mode
84+
To run your application with *production* environment configuration, execute grunt as follows:
85+
```bash
86+
$ grunt prod
87+
```
88+
* explore ```config/env/production.js``` for production environment configuration options
89+
90+
### Running with TLS (SSL)
91+
Application will start by default with secure configuration (SSL mode) turned on and listen on port 8443.
92+
To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:
93+
```bash
94+
$ sh ./scripts/generate-ssl-certs.sh
95+
```
96+
Windows users can follow instructions found [here](http://www.websense.com/support/article/kbarticle/How-to-use-OpenSSL-and-Microsoft-Certification-Authority).
97+
After you've generated the key and certificate, place them in the *config/sslcerts* folder.
98+
99+
Finally, execute grunt's prod task ```grunt prod```
100+
* enable/disable SSL mode in production environment change the ```secure``` option in ```config/env/production.js```
101+
102+
81103
## Testing Your Application
82104
You can run the full test suite included with MEAN.JS with the test task:
83105

84-
```
106+
```bash
85107
$ grunt test
86108
```
87109

88110
This will run both the server-side tests (located in the app/tests/ directory) and the client-side tests (located in the public/modules/*/tests/).
89111

90112
To execute only the server tests, run the test:server task:
91113

92-
```
114+
```bash
93115
$ grunt test:server
94116
```
95117

96118
And to run only the client tests, run the test:client task:
97119

98-
```
120+
```bash
99121
$ grunt test:client
100122
```
101123

@@ -122,14 +144,6 @@ $
122144
$ docker run -p 3000:3000 -p 35729:35729 -v /Users/mdl/workspace/mean-stack/mean/public:/home/mean/public -v /Users/mdl/workspace/mean-stack/mean/app:/home/mean/app --link db:db_1 mean
123145
```
124146

125-
## Running in a secure environment
126-
To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:
127-
```bash
128-
$ sh ./scripts/generate-ssl-certs.sh
129-
```
130-
Windows users can follow instructions found [here](http://www.websense.com/support/article/kbarticle/How-to-use-OpenSSL-and-Microsoft-Certification-Authority).
131-
After you've generated the key and certificate, place them in the *config/sslcerts* folder.
132-
133147
## Getting Started With MEAN.JS
134148
You have your application running, but there is a lot of stuff to understand. We recommend you go over the [Official Documentation](http://meanjs.org/docs.html).
135149
In the docs we'll try to explain both general concepts of MEAN components and give you some guidelines to help you improve your development process. We tried covering as many aspects as possible, and will keep it updated by your request. You can also help us develop and improve the documentation by checking out the *gh-pages* branch of this repository.

0 commit comments

Comments
 (0)