Skip to content

Commit 1c73833

Browse files
committed
Update README.md
1 parent 481189a commit 1c73833

File tree

1 file changed

+104
-4
lines changed

1 file changed

+104
-4
lines changed

README.md

Lines changed: 104 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MEANStack
1+
# MEANStack.io
22
*bringing together the best of MEAN MongoDB, Express, AngularJS and Node.js*
33

44
Is a solution full-stack JavaScript, based on MongoDB, Express, AngularJS, Node.js and another stack of packages.
@@ -18,11 +18,111 @@ Is a solution full-stack JavaScript, based on MongoDB, Express, AngularJS, Node.
1818
Are some of the packages that we use to make this dream come true.
1919

2020
## Getting Started
21-
Getting started ? go to the official page [meanstack.developscript.com](http://meanstack.developscript.com/getting-started)
21+
22+
### Prerequisites
23+
Install Node.js e MongoDB.
24+
25+
#### Install Node.js
26+
Installing Node.js via package manager access <a href="https://nodejs.org/en/download/package-manager/">https://nodejs.org/en/download/package-manager/</a>
27+
28+
##### Notes
29+
if you use Debian and Ubuntu based Linux distributions be sure to install **build-essential**.
30+
```bash
31+
$ sudo apt-get install -y build-essential
32+
```
33+
34+
if you use Enterprise Linux and Fedora be sure to install **gcc-c++ make**.
35+
```bash
36+
$ yum install gcc-c++ make
37+
```
38+
39+
#### Install MongoDB
40+
Installing MongoDB access <a href="https://docs.mongodb.org/manual/installation/">https://docs.mongodb.org/manual/installation/</a>
41+
42+
##### Note
43+
If you've never worked with a MongoDB read in your documentation before you install it, official documentation access, <a href="https://docs.mongodb.org/manual/">https://docs.mongodb.org/manual/</a>
44+
45+
### Installation
46+
47+
#### Before installing
48+
Before you begin installing MEANStack we will update the NPM and soon after installing Gulp, Bower and nodemon in the global scope.
49+
50+
##### Updating NPM
51+
```bash
52+
$ npm update -g npm
53+
```
54+
55+
##### Install Gulp
56+
```bash
57+
$ npm install -g gulp
58+
```
59+
60+
##### Install Bower
61+
```bash
62+
$ npm install -g bower
63+
```
64+
65+
##### Install Nodemon
66+
Nodemon is a utility that will monitor for any changes in your source and automatically restart your server. Perfect for development. Install it using npm.
67+
```bash
68+
$ npm install -g nodemon
69+
```
70+
71+
##### Note
72+
If you already have the Gulp and Bower recommend updates them.
73+
```bash
74+
$ npm update -g gulp bower
75+
```
76+
77+
#### Install
78+
**The first step** is to clone the repository GitHub.
79+
```bash
80+
$ git clone git@github.com:developscript/meanstack.io.git
81+
```
82+
83+
**The second step** is to install the back-end dependencies.
84+
```bash
85+
$ npm install
86+
```
87+
88+
**The third step** is to install the front-end dependencies.
89+
```bash
90+
$ bower install
91+
```
92+
93+
**The fourth step** is to configure the application. For this we have a sample file "config/config.example.js" copy and rename it to "config/config-development.js".
94+
```bash
95+
$ cp config/config.example.js config/config-development.js
96+
```
97+
98+
##### Configuration file.
99+
The file "config/config-development.js" represents the configuration of your environment. What ? within package.json we have:
100+
```js
101+
"start": "NODE_ENV=development nodemon ./bin/www"
102+
```
103+
The "NODE_ENV" property sets which environment setting will be used. Example:
104+
```js
105+
"start": "NODE_ENV=production nodemon ./bin/www" // Its configuration file is "config/config-production.js".
106+
```
107+
108+
**The fifth step** is to run Gulp.
109+
```bash
110+
$ gulp
111+
```
112+
113+
**The sixth step** is to start the application.
114+
```bash
115+
$ npm start
116+
```
117+
118+
If you want to use the Gulp with Browsersync
119+
```bash
120+
$ gulp watch
121+
```
22122

23123
## Documentation
24-
Documentation can be found on the [meanstack.developscript.com](http://meanstack.developscript.com/documentation)
124+
Documentation can be found on the [meanstack.io](http://meanstack.io/documentation)
25125

26126
## Copyright & License
27127

28-
Copyright © 2016 Developscript - Licensed under [MIT](https://github.com/developscript/meanstack/blob/master/License).
128+
Copyright © 2016 Developscript - Licensed under [MIT](https://github.com/developscript/meanstack.io/blob/master/License).

0 commit comments

Comments
 (0)