Project Overview

What follows is an overfiew of the files/folders in your newly generated project.
Project Root
1
.babelrc // configuration for [Babel], a JavaScript transpiler
2
.editorconfig // config file used to keep conistent file editing across text editors
3
.eslintrc // all of the rules applying to the ESLint JavaScript linter
4
.travis.yml // a sample configuration file for Travis CI
5
.yo-rc.json // a configuration file for the Angular Full-Stack Generator
6
gulpfile.babel.js // Gulp task runner file
7
karma.conf.js // Karma browser testing configuration
8
mocha.conf.js // Mocha test framework configuration
9
mocha.global.js // teardown file for Mocha
10
package.json // npm manifest, contains information for all project dependencies
11
protractor.conf.js // configuration for Protractor e2e test framework
12
README.md // a readme file generator based on your options, for your scaffolded project
13
spec.js // test file for Webpack used by Karma
14
webpack.make.js // main file for Webpack configuration
15
    //The following export the config from `webpack.make.js` for their respective build targets:
16
    webpack.dev.js
17
    webpack.test.js
18
    webpack.build.js
Copied!
client/
1
│   .eslintrc // eslint config for client files
2
│   polyfills.js // imports of polyfills
3
│   app.template.html // template for the root HTML file of your app
4
│
5
├───app
6
│   │   app.config.js // contains app-wide configuration code
7
│   │   app.constants.js // gets injected with constants from `server/config/environment/shared.js`
8
│   │   app.{js,ts} // root JavaScript file of your app
9
│   │   app.{css,scss,stylus,less} // root CSS file of your app
10
│   │
11
│   ├───account // pages related to login / signup / user settings
12
│   │   │   account.routes.js // route information
13
│   │   │   index.js // account module root
14
│   │   │
15
│   │   ├───login
16
│   │   ├───settings
17
│   │   └───signup
18
│   │
19
│   ├───admin // site admin page
20
│   │
21
│   └───main // main component, homepage
22
│
23
├───assets // where static assets are stored
24
│
25
└───components
26
    ├───auth
27
    │       auth.module.js // module containing auth components
28
    │       auth.service.js // authentication service
29
    │       interceptor.service.js // intercepts requests and adds tokens if needed. Also redirects 401s to the login page.
30
    │       router.decorator.js // facilitates auth-based routing configuration
31
    │       user.service.js // user resource service
32
    │
33
    ├───footer
34
    │
35
    ├───modal
36
    │
37
    ├───navbar
38
    │
39
    ├───oauth-buttons // buttons for oauth login on signup / login pages
40
    │
41
    ├───socket
42
    │       socket.mock.js // mock service for unit testing
43
    │       socket.service.js // service for Socket IO integration
44
    │
45
    ├───ui-router
46
    │       ui-router.mock.js // mock service for unit testing
47
    │
48
    └───util // general utility service
Copied!
server/
1
│   .eslintrc // server-specific ESLint config, imports rules from root file
2
│   app.js // root server module
3
│   index.js // imports `app.js`. Enables Babel require hook when in development mode.
4
│   routes.js // imports / config for server endpoints
5
│
6
├───api
7
│   ├───thing
8
│   │       index.js // root module
9
│   │       index.spec.js // root module tests
10
│   │       thing.controller.js // endpoint logic
11
│   │       thing.events.js // endpoint events (save, delete, etc) logic
12
│   │       thing.integration.js // integration tests
13
│   │       thing.model.js // Mongoose / Sequelize data model
14
│   │       thing.socket.js // Socket IO logic / config
15
│   │
16
│   └───user // API for Users
17
│
18
├───auth
19
│   │   auth.service.js
20
│   │   index.js // imports local/oauth auth modules
21
│   │
22
│   ├───local // regular auth, signed up directly via your site
23
│   ├───google // Google OAuth
24
│   └───<etc...>
25
│
26
└───config
27
    │   express.js // Express server setup
28
    │   local.env.js // ignored by Git
29
    │   local.env.sample.js // sensitive environment variables are stored here, and added at server start. Copy to `local.env.js`.
30
    │   seed.js // re-seeds database with fresh data
31
    │   socketio.js // Socket IO configuration / imports
32
    │
33
    └───environment
34
            development.js
35
            index.js
36
            production.js
37
            shared.js // config constants shared with the client code
38
            test.js
Copied!
e2e/
End-To-End testing files (use by Protractor with Mocha)
Getting Started - Previous
Running
Next - Developing
Overview
Last modified 2yr ago
Copy link
Contents
Project Root

`client/`

`server/`

`e2e/`
