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
-118Lines changed: 0 additions & 118 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,124 +96,6 @@ Available generators:
96
96
Check out our [documentation home page](/docs/index.md).
97
97
98
98
99
-
## Bower Components
100
-
101
-
The following packages are always installed by the [app](#app) generator:
102
-
103
-
* angular
104
-
* angular-cookies
105
-
* angular-mocks
106
-
* angular-resource
107
-
* angular-sanitize
108
-
* es5-shim
109
-
* font-awesome
110
-
* json3
111
-
* jquery
112
-
* lodash
113
-
114
-
These packages are installed optionally depending on your configuration:
115
-
116
-
* angular-route
117
-
* angular-ui-router
118
-
* angular-socket-io
119
-
* angular-bootstrap
120
-
* bootstrap
121
-
122
-
All of these can be updated with `bower update` as new versions are released.
123
-
124
-
## Injection
125
-
126
-
A grunt/gulp task looks for new files in your `client/app` and `client/components` folder and automatically injects them in the appropriate places based on an injection block.
127
-
128
-
*`less` files into `client/app/app.less`
129
-
*`scss` files into `client/app/app.scss`
130
-
*`stylus` files into `client/app/app.styl`
131
-
*`css` files into `client/index.html`
132
-
*`js` files into `client/index.html`
133
-
*`babel`/`typescript` temp `js` files into `client/index.html`
134
-
*`typescript types` into `tsconfig.client.json` & `tsconfig.client.test.json`
135
-
136
-
137
-
## Configuration
138
-
Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.
139
-
140
-
A `.yo-rc` file is generated for helping you copy configuration across projects, and to allow you to keep track of your settings. You can change this as you see fit.
141
-
142
-
## Testing
143
-
144
-
Running `grunt test` will run the client and server unit tests with karma and mocha.
145
-
146
-
Use `grunt test:server` to only run server tests.
147
-
148
-
Use `grunt test:client` to only run client tests.
149
-
150
-
**Protractor tests**
151
-
152
-
To setup protractor e2e tests, you must first run
153
-
154
-
`npm run update-webdriver`
155
-
156
-
Use `grunt test:e2e` to have protractor go through tests located in the `e2e` folder.
157
-
158
-
**Code Coverage**
159
-
160
-
Use `grunt test:coverage` to run mocha-istanbul and generate code coverage reports.
161
-
162
-
`coverage/server` will be populated with `e2e` and `unit` folders containing the `lcov` reports.
163
-
164
-
The coverage taget has 3 available options:
165
-
-`test:coverage:unit` generate server unit test coverage
166
-
-`test:coverage:e2e` generate server e2e test coverage
167
-
-`test:coverage:check` combine the coverage reports and check against predefined thresholds
168
-
169
-
**when no option is given `test:coverage` runs all options in the above order*
170
-
171
-
**Debugging**
172
-
173
-
Use `grunt serve:debug` for a more debugging-friendly environment.
174
-
175
-
## Environment Variables
176
-
177
-
Keeping your app secrets and other sensitive information in source control isn't a good idea. To have grunt launch your app with specific environment variables, add them to the git ignored environment config file: `server/config/local.env.js`.
178
-
179
-
## Project Structure
180
-
181
-
Overview
182
-
183
-
├── client
184
-
│ ├── app - All of our app specific components go in here
185
-
│ ├── assets - Custom assets: fonts, images, etc…
186
-
│ ├── components - Our reusable components, non-specific to to our app
187
-
│
188
-
├── e2e - Our protractor end to end tests
189
-
│
190
-
└── server
191
-
├── api - Our apps server api
192
-
├── auth - For handling authentication with different auth strategies
193
-
├── components - Our reusable or app-wide components
194
-
├── config - Where we do the bulk of our apps configuration
195
-
│ └── local.env.js - Keep our environment variables out of source control
196
-
│ └── environment - Configuration specific to the node environment
197
-
└── views - Server rendered views
198
-
199
-
An example client component in `client/app`
200
-
201
-
main
202
-
├── main.js - Routes
203
-
├── main.controller.js - Controller for our main route
204
-
├── main.controller.spec.js - Test
205
-
├── main.html - View
206
-
└── main.less - Styles
207
-
208
-
An example server component in `server/api`
209
-
210
-
thing
211
-
├── index.js - Routes
212
-
├── thing.controller.js - Controller for our `thing` endpoint
213
-
├── thing.model.js - Database model
214
-
├── thing.socket.js - Register socket events
215
-
└── thing.spec.js - Test
216
-
217
99
## Contribute
218
100
219
101
See the [contributing docs](https://github.com/DaftMonk/generator-angular-fullstack/blob/master/contributing.md)
0 commit comments