You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-6Lines changed: 21 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,20 @@ A short introduction of this app could easily go here.
8
8
* Routing using [ui-router](https://github.com/angular-ui/ui-router)
9
9
* Models like ORM using [angular-restmod](https://github.com/platanus/angular-restmod)
10
10
* Authentication (token-based) using [satellizer](https://github.com/sahat/satellizer)
11
+
* Translation (i18n) using [angular-translate](https://github.com/angular-translate/angular-translate)
12
+
13
+
## Default rules, architecture and development support
14
+
15
+
* Default main module is `app` and namespace sub-modules with this, like `app.authentication` module or `app.users` this referencing to module of users
16
+
* Main entry point is `index.html` of `app` directory. There, all styles, scripts and dependencies are injected
17
+
* Default routing added to main module `app` named `router.js` where you can define routes with templates, controllers and more
18
+
* Default translation added to main module `app` named `i18n.js` where you can define language translations and get all file messages from `locales` directory
19
+
* Inside `styles` directory you can work with raw css, less or sass if you prefer. Then you have selected how work, delete unused files
20
+
* Added example of controller named `app.authentication.signin`. This name is related to `module.controller_name` without the `controller` suffix because it is added to `controllers` directory
21
+
* Added example of model using angular-restmod, named `app.user`. The model is user but this is added to global and main module called `app`
22
+
* When you add new dependency manually (downloading file) or using bower, put them into `vendor` directory and then add import style / script inside config-build.js (remember execute `gulp build`)
23
+
* When you add favicon, images and fonts, put them into `public` folder and then reference them inside `index.html` of `app` directory
24
+
* You can re-define the name of main module inside `app.js` and also the naming conventions, project structure, dependencies and more. However we recommend these rules for better approach
11
25
12
26
## Prerequisites
13
27
@@ -24,18 +38,19 @@ You will need the following things properly installed on your computer.
24
38
*`npm install`
25
39
*`bower install`
26
40
27
-
## Running, build and live reload (AIO command)
41
+
## Running, full-build and serve development server with live reload (AIO command)
28
42
29
43
*`gulp`
30
-
* Visit your app at [http://localhost:8000](http://localhost:8000).
44
+
* Visit your app at [http://localhost:3000](http://localhost:3000) the port can be changed 3000 is browser-sync default port.
31
45
32
-
## Running / Development
46
+
## Running only development server with live reload
33
47
34
48
*`gulp server`
35
-
* Visit your app at [http://localhost:8000](http://localhost:8000).
49
+
* Visit your app at [http://localhost:3000](http://localhost:3000).
36
50
37
51
## Building
38
52
39
-
*`gulp build-inject`
40
-
53
+
*`gulp build`
54
+
* Check-out the dist folder with the last files and changes. This execute full-build with styles, scripts, templates and more.
55
+
* Always use this command when you add new script / style into config-build.js.
0 commit comments