Skip to content

Commit df66577

Browse files
vash15vash15
committed
documentation
1 parent 10a98bb commit df66577

File tree

5 files changed

+71
-59
lines changed

5 files changed

+71
-59
lines changed

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 - 2017 Baggio Matteo & Belluco Michele
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

Lines changed: 36 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ $ npm install -g node-eve
1515
1616
Commands:
1717
18-
init [name] Crea il template di una app
19-
build [options] [type] [config] Compila l'applicazione
20-
start [options] [config] Esegue l'applicazione
21-
test [options] <unit> Testa l'applicazione
22-
extract [options] Estrae le stringhe dall'applicazione e le restituisce in un file per la traduzione
23-
prepare <section> Util for prepare a section
18+
init [name] Initialize an application structure
19+
build [options] [type] [config] Build app width type
20+
start [options] [config] Build an app in develop mode and start webserver
21+
test [options] <unit> Build and start webserver for test
22+
extract [options] Extract all strings for translation
23+
2424
Options:
2525
2626
-h, --help output usage information
@@ -44,9 +44,14 @@ $ eve build // Alias of ...
4444
$ eve build dev // Compile application of type development. Also provide source map file.
4545
$ eve build dist // Compile application of type production. The code is minified.
4646
$ eve build pub // Compile application of type production. The code is minified and, optionally, obfuscated with jScramble.
47+
48+
// Specify a custom configuration file
49+
50+
$ eve build pub --config config-custom.json
51+
4752
```
4853

49-
### eve start
54+
### eve start [options] [config]
5055

5156
```
5257
$ eve start
@@ -64,6 +69,11 @@ Also it starts a web server, so as to allow the application display in browser.
6469

6570
```
6671
$ eve start -p 5001
72+
73+
// Specify a custom configuration file
74+
75+
$ eve start --config config-custom.json
76+
6777
```
6878

6979

@@ -93,13 +103,14 @@ Generate file for translations strings. File oupts are `po`, `json` or `txt`. Mo
93103
"license": "",
94104
"main": "./lib/app.js",
95105
"scripts": {
96-
"start": "eve start"
106+
"start": "eve start",
107+
"dist": "eve build dist"
108+
"pub": "eve build pub",
109+
"pre": "eve build pub --config config-pre-production.json"
97110
},
98111
"eve-language": "es6",
99-
"eve-version": "2.0.0",
100-
"eve-configs-developement": {},
101-
"eve-configs-production": {},
102-
"eve-configs": {}
112+
"eve-version": "2.3.0",
113+
"eve-build-date": "2017-4-26"
103114
}
104115
```
105116

@@ -124,60 +135,34 @@ Defaults:
124135
}
125136
```
126137

127-
### eve-configs-developement
138+
### config-developement.json file
128139

129140
Punt into object the variables for developement mode.
130141

131-
### eve-configs-production
142+
### config-production.json file
132143

133144
Punt into object the variables for production mode.
134145

135-
### eve-configs
146+
### config.json file
136147

137148
The object is generated based on the compilation mode (`development` or `production`). Into your app require this object for read the variables.
138149

139-
## Tips & Tricks
140-
141-
### File limit
142-
143-
If `EMFILE` file error is triggered use the command `ulimit -n 2048` to fix it.
144-
145-
### Set environment variables on Windows
150+
### .everc file
146151

147-
To set environment variables in Windows use the tool from ***System in Control Panel*** (or by typing `environment` into the search box in start menu). For more details read this discussion on [Stackoverflow](http://stackoverflow.com/a/9250168).
152+
This is a file configuration for eve.
148153

149-
### Set environment variables on Linux or Mac
154+
Params:
150155

156+
- `editor`: this field indicates the editor that will open when the user clicks on the notification.
151157

152158
```
153-
`nano ~/.profile`
154-
155-
export JSCRAMBLER_ACCESSKEY=<MY KEY>
156-
export JSCRAMBLER_SECRETKEY=<MY SECRET>
159+
{
160+
"editor": "atom"
161+
}
157162
```
158163

164+
## Tips & Tricks
159165

166+
### File limit
160167

161-
## LICENSE
162-
163-
The MIT License (MIT)
164-
165-
Copyright (c) 2015 - 2016
166-
167-
Permission is hereby granted, free of charge, to any person obtaining a copy
168-
of this software and associated documentation files (the "Software"), to deal
169-
in the Software without restriction, including without limitation the rights
170-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
171-
copies of the Software, and to permit persons to whom the Software is
172-
furnished to do so, subject to the following conditions:
173-
174-
The above copyright notice and this permission notice shall be included in
175-
all copies or substantial portions of the Software.
176-
177-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
178-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
179-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
180-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
181-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
182-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
183-
THE SOFTWARE.
168+
If `EMFILE` file error is triggered use the command `ulimit -n 2048` to fix it.

‎RELEASE.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1-
21
# Release notes
32

3+
## 2.3.0
4+
5+
- eve configurations have been moved to separate files.
6+
- New param `--config` for build a javascript.
7+
- Bugfix for build scss width `pub` mode.
8+
- Upgrade jscrambler.
9+
- Create a eve config file `.everc`.
10+
- Developed a simple example.
11+
12+
413
## 2.2.1
514

615
- Bug fix unit test

‎example/config.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"author": "",
77
"license": "",
88
"env": "production",
9-
"build-date": "2017-05-08",
10-
"API_KEY": "KEY_FOR_PRODUCTION",
11-
"build-date-time": "2017-05-08 08:59:18"
9+
"build-date": "2017-05-09",
10+
"API_KEY": "KEY_FOR_PRE_PRODUCTION",
11+
"build-date-time": "2017-05-09 17:45:51"
1212
}

‎example/package.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,5 @@
1818
"eve-build-date": "2017-4-26",
1919
"eve-configs-development": {},
2020
"eve-configs-production": {},
21-
"eve-configs": {
22-
"env": "development",
23-
"TEST_VAR": "package.json"
24-
}
21+
"eve-configs": {}
2522
}

0 commit comments

Comments
 (0)