This repository has been archived by the owner on May 12, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
489 lines (400 loc) · 24.7 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="ie ie6" lang="en"> <![endif]-->
<!--[if IE 7 ]><html class="ie ie7" lang="en"> <![endif]-->
<!--[if IE 8 ]><html class="ie ie8" lang="en"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!-->
<html lang="en">
<!--<![endif]-->
<head>
<style>
#mevn{
background-color:rgba(41, 0, 43, 0.973);
}
#mevn1{
background-color:rgba(41, 0, 43, 0.973);
}
#TextColor{
color:rgba(235, 213, 17, 0.747);
}
#intro{
}
#textg{
font-size:2.125rem
}
</style>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<meta name="description" content="">
<meta name="author" content="">
<meta name="keywords" content="">
<title>Documentation - Mevn-Cli</title>
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
<link rel="stylesheet" type="text/css" href="fonts/font-awesome-4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="css/stroke.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.css">
<link rel="stylesheet" type="text/css" href="css/animate.css">
<link rel="stylesheet" type="text/css" href="css/prettyPhoto.css">
<link rel="stylesheet" type="text/css" href="css/style.css">
<link rel="stylesheet" type="text/css" href="js/syntax-highlighter/styles/shCore.css" media="all">
<link rel="stylesheet" type="text/css" href="js/syntax-highlighter/styles/shThemeRDark.css" media="all">
<!-- CUSTOM -->
<link rel="stylesheet" type="text/css" href="css/custom.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div id="wrapper">
<div class="container">
<section id="top" class="section docs-heading">
<div class="row" id="Title">
<div class="col-md-12" >
<div class="big-title text-center" id="mevn1">
<header >
<h1 align="center"> <pre id="mevn">
<font color="#3297E3"> __ __ _ _ </font>
<font color="#3297E3"> | \/ | _____ ___ __ ___| (_)</font>
<font color="#3297E3"> | |\/| |/ _ \ \ / / '_ \ _____ / __| | |</font>
<font color="#3297E3"> | | | | __/\ V /| | | |_____| (__| | |</font>
<font color="#3297E3"> |_| |_|\___| \_/ |_| |_| \___|_|_|</font>
<p id="TextColor" align="center">Mevn-Cli Documentation Version 1.0.0</p>
</pre> </h1>
</header>
</div>
<!-- end title -->
</div>
<!-- end 12 -->
</div>
<!-- end row -->
<hr>
</section>
<!-- end section -->
<div class="row">
<div class="col-md-3">
<nav class="docs-sidebar" data-spy="affix" data-offset-top="300" data-offset-bottom="200" role="navigation">
<ul class="nav">
<li><a href="#line1">Getting Started</a></li>
<li><a href="#line2">Available Commands</a></li>
<li><a href="#line7">Using It</a>
<ul class="nav">
<li><a href="#line7_1">Initialising A Project</a></li>
<li><a href="#line7_2">Routes</a></li>
<li><a href="#line7_3">Models-File</a></li>
<li><a href="#line7_4">Controller-File</a></li>
<li><a href="#line7_5">Config-File</a></li>
<li><a href="#line7_6">Server</a></li>
<li><a href="#line7_7">Client</a></li>
</ul>
</li>
<li><a href="#line8">File Structure</a>
<!--<ul class="nav">
<li><a href="#line8_1">Index.js</a></li>
<li><a href="#line8_2">Initlib.js</a></li>
<li><a href="#line8_3">routeslib.js</a></li>
<li><a href="#line8_4">modelslib.js</a></li>
<li><a href="#line8_5">controllerlib.js</a></li>
<li><a href="#line8_6">configlib.js</a></li>
<li><a href="#line8_7">client.js</a></li>
<li><a href="#line8_8">server.js</a></li>
<li><a href="#line8_9">user_schema.js</a></li>
<li><a href="#line8_10">user_controller.js</a></li>
<li><a href="#line8_11">figlet.js</a></li>
<li><a href="#line8_12">index.js(routes)</a></li>
</ul>-->
</li>
<li><a href="#line10">Version History (Changelog)</a></li>
<li><a href="#line11">Copyright and license</a></li>
</ul>
</nav >
</div>
<div class="col-md-9">
<section class="welcome">
<div class="row">
<div class="col-md-12 left-align">
<h2 class="dark-text">Documentation<hr></h2>
<div class="row">
<div class="col-md-12 full">
<div class="intro1">
<ul>
<li><strong>Version : </strong> v 1.0</li>
<li><strong>Authors : </strong>Abraham Philip,Thomas Johan Jojo, Ananthu Anil, <a href="https://www.github.com/jamesgeorge007" target="_blank">James George</a> and <a href="https://www.github.com/alanmathew333" target="_blank">Alan Mathew</a></li>
<li><strong>License : </strong> <a href="https://opensource.org/licenses/MIT" target="_blank">MIT</a></li>
</ul>
</div>
<br>
<br>
<hr>
<div id="intro">
<p>MEVN is a scaffolding tool which makes it easy to build universal apps using Mongo, Express, Vue and NodeJS. It minimises the setup time and gets you up to speed using proven technologies.
</p>
</div>
</div>
</div>
<!-- end row -->
</div>
</div>
</section>
<section id="line1" class="section">
<div class="row">
<div class="col-md-12 left-align">
<h2 class="dark-text">Getting Started <a href="#top">#back to top</a><hr></h2>
</div>
<!-- end col -->
</div>
<!-- end row -->
<div class="row">
<div class="col-md-12">
<p>A <strong>CLI tool</strong> for getting started with MEVN stack. It offers a super simple boilerplate project and additional utilities for building a MEVN app. It helps for beginner developers to easily create a template for their Web application development.</p>
<h4 class="dark-text">Prerequisites</h4>
<p>________________</p>
<p>
<ul class="pre3">
<li><strong>Npm</strong> - it is a package manager for the JavaScript programming language.
</li>
<li><strong>Node.js</strong> -Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code
outside of a browser.
</li>
<li><strong>Git</strong> - Git is a version control system for tracking changes in computer files and coordinating work on those files among multiple people.
It is primarily used for source code management in software development.
</li>
</ul>
</p>
<h4 class="dark-text">Installing</h4>
<p>
To install the package :-
</p>
<pre class="pre4" style=" margin-bottom:-5px;margin-top: -5px;"><code><b>npm install -g mevn-cli</b>
</code></pre>
<h4 class="dark-text" >Quickstart</h4>
<pre class="pre4"> <code class=pre4_1><b>
npm install -g mevn-cli
mevn-cli init "Desired File Name"
</b></code></pre>
</div>
<!-- end col -->
</div>
<!-- end row -->
</section>
<!-- end section -->
<section id="line2" class="section">
<div class="row">
<div class="col-md-12 left-align">
<h2 class="dark-text">Available Commands <a href="#top">#back to top</a><hr></h2>
<h4 class="dark-text" id="textg">Initial Commands</h4>
<pre class="pre4"> <code><b>
<ol style="font-size:1vw;padding:auto; margin-top:-70px; margin-bottom:-20px">
<li> mevn-cli init appname - <font style="color:rgba(43, 40, 40, 0.411); padding:inherit;">To initialize the project.</font></li>
</ol></b></code></pre></li>
<h4 class="dark-text" id="textg">General Commands</h4>
<pre class="pre4"> <code><b>
<ol style="font-size:1vw;margin-top:-60px; margin-bottom:-10px">
<li><strong size="50%"> mevn-cli create:route</strong> <font style="color:rgba(43, 40, 40, 0.411);">- To create the Routes-File(API)</font></li>
<li> mevn-cli create:model <font style="color:rgba(12, 11, 11, 0.411);">- To create the Models-File(SCHEMA)</font> </li>
<li>mevn-cli create:controller <font style="color:rgba(14, 13, 13, 0.397);">- To create the Controller-File</font></li>
<li>mevn-cli create:config<font style="color:rgba(34, 32, 32, 0.411);">- To create the Config-File</font> </li>
</ol></b></code></pre>
<h4 class="dark-text" id="textg">Server Commands</h4>
<pre class="pre4"> <code><b>
<ol style="font-size:1vw;margin-top:-50px; margin-bottom:-10px;">
<li>mevn-cli run:server - <font style="color:rgba(43, 40, 40, 0.411);">To run the Server</font></li>
<li> mevn-cli run:client - <font style="color:rgba(43, 40, 40, 0.411);">To run the Client</font></li>
</ol></b></code></pre></li>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<section id="line7" class="section">
<div class="row">
<div class="col-md-12 left-align">
<h2 class="dark-text">Using It <a href="#top">#back to top</a><hr></h2>
</div>
<!-- end col -->
</div>
<!-- end row -->
<div class="row">
<div class="col-md-8">
<a href="upload/INIT.gif" data-rel="prettyPhoto"><img src="images/upload/INIT.gif" alt="" class="img-responsive img-thumbnail" usemap="images/upload/INIT.gif"></a>
</div>
<div class="col-md-4">
<h4 id="line7_1">Initialising A Project - <a href="#top">#back to top</a></h4>
<p>
The Project is initialised by entering the Init command and entering your desired AppName and Type of BoilerPlate you want.
</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<div class="row">
<div class="col-md-8">
<a href="upload/route.gif"><img src="images/upload/route.gif" alt="" class="img-responsive img-INIT"></a>
</div>
<div class="col-md-4">
<h4 id="line7_2">Routes-File - <a href="#top">#back to top</a></h4>
<p>This Command is used to create the Routes File required to generate necessary code for routing purposes.</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<div class="row">
<div class="col-md-8">
<a href="upload/models.gif"><img src="images/upload/models.gif" alt="" class="img-responsive img-thumbnail"></a>
</div>
<div class="col-md-4">
<h4 id="line7_3">Models-File - <a href="#top">#back to top</a></h4>
<p>This Command is used to create Models-File which is used for creating some Database Schema Definitions.</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<div class="row">
<div class="col-md-8">
<a href="upload/controller.gif"><img src="images/upload/controller.gif" alt="" class="img-responsive img-thumbnail"></a>
</div>
<div class="col-md-4">
<h4 id="line7_4">Controller-File - <a href="#top">#back to top</a></h4>
<p>This is used to create the controller file which contains the logic part.</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<div class="row">
<div class="col-md-8">
<a href="upload/config.gif"><img src="images/upload/config.gif" alt="" class="img-responsive img-thumbnail"></a>
</div>
<div class="col-md-4">
<h4 id="line7_5">Config-File - <a href="#top">#back to top</a></h4>
<p>It is used to create the Config-File which grabs the database from the user.</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<div class="row">
<div class="col-md-8">
<a href="upload/Server_Small.gif"><img src="images/upload/Server_Small.gif" alt="" class="img-responsive img-thumbnail"></a>
</div>
<div class="col-md-4">
<h4 id="line7_6">Server - <a href="#top">#back to top</a></h4>
<p>This command is used to Run Server.</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
<hr>
<div class="row">
<div class="col-md-8">
<a href="upload/Client1_Small.gif"><img src="images/upload/Client1_Small.gif" alt="" class="img-responsive img-thumbnail"></a>
</div>
<div class="col-md-4">
<h4 id="line7_7">Client - <a href="#top">#back to top</a></h4>
<p>This command is used to Run Client.</p>
</div>
<!-- end col -->
</div>
<!-- end row -->
</section>
<!-- end section -->
<section id="line8" class="section">
<div class="row">
<div class="col-md-12 left-align">
<h2 class="dark-text">File Structure <a href="#top">#back to top</a><hr></h2>
</div>
<!-- end col -->
</div>
<!-- end row -->
<div class="row">
<div class="row">
<div class="col-md-12">
<h4 id="line8_1">File Hierarchy</h4>
<p>Modules are the way of organising different domain-specific modules in the project. MEVN-CLI contains the following Modules.</p>
<pre class="ps-container ps-theme-default" data-ps-id="44e9037b-7528-a3db-f12a-1a7ff0121587"><code>| - Post
| - __Mevn-Cli__- // all the tests for this module goes here
| - lib // Sub components of this module
| - Commands
| - routeslib.js
| - configlib.js.js
| - modelslib.js
| - controllerlib.js
| - files
|-external //sub components of this module
|-figlet.js
| - Run // Sub components of this module
| - client.js
| - server.js
| - config.json
| - index.js
| - package-lock.json
| - package.json
</code><div class="ps-scrollbar-x-rail" style="left: 0px; bottom: 3px;"><div class="ps-scrollbar-x" tabindex="0" style="left: 0px; width: 0px;"></div></div><div class="ps-scrollbar-y-rail" style="top: 0px; right: 3px;"><div class="ps-scrollbar-y" tabindex="0" style="top: 0px; height: 0px;"></div></div></pre>
</section>
<section id="line10" class="section"><!-- end section -->
<div class="row" id="change">
<div class="col-md-12">
<h4 class="dark-text">Changelog</h4>
<hr style="color:black;">
<pre class="brush: html">
------------------------- Version 3.8.3 - May 7th, 2015 ---------------------------
------------------------------------------------------------------------------------
- Minor bug fixes
- Code clean up andd add elegant-spinner
- Added pwa boilerplate
- expand scope of commands
- Added tables and modif
- Added new command
- Command to run the app
- Added more commands
- Added Init Command
- Created Basic structure
- Initial commit
</pre>
</section>
</div>
</div>
<section id="line11" class="section">
<div class="row">
<div class="col-md-12 left-align">
<h2 class="dark-text">Copyright and license <a href="#top">#back to top</a><hr></h2>
</div>
<!-- end col -->
</div>
<!-- end row -->
<div class="row">
<div class="col-md-12">
<p>Code released under the <a href="https://opensource.org/licenses/MIT" target="_blank">MIT</a> License.</p>
<p>For more information about copyright and license check <a href="https://choosealicense.com/" target="_blank">choosealicense.com</a>.</p>
</div>
</div>
<!-- end row -->
</section>
<!-- end section -->
</div>
<!-- // end .col -->
</div>
<!-- // end .row -->
</div>
<!-- // end container -->
</div>
<!-- end wrapper -->
<script src="js/jquery.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/retina.js"></script>
<script src="js/jquery.fitvids.js"></script>
<script src="js/wow.js"></script>
<script src="js/jquery.prettyPhoto.js"></script>
<!-- CUSTOM PLUGINS -->
<script src="js/custom.js"></script>
<script src="js/main.js"></script>
<script src="js/syntax-highlighter/scripts/shCore.js"></script>
<script src="js/syntax-highlighter/scripts/shBrushXml.js"></script>
<script src="js/syntax-highlighter/scripts/shBrushCss.js"></script>
<script src="js/syntax-highlighter/scripts/shBrushJScript.js"></script>
</body>
</html>