The generated files #

• config/ contains the configuration files for the app
  • default.json contains the basic application configuration
  • production.json files override default.json when in production mode by setting NODE_ENV=production. For details, see the configuration API documentation
• node_modules/ our installed dependencies which are also added in the package.json
• public/ contains static files to be served. A sample favicon and index.html (which will show up when going directly to the server URL) are already included.
• src/ contains the Feathers server code.
  • hooks/ contains our custom hooks
  • services/ contains our services
    • users/ is a service that has been generated automatically to allow registering and authenticating users
      • users.class.ts is the service class
      • users.hooks.ts initializes Feathers hooks for this service
      • users.service.ts registers this service on our Feathers application
  • middleware/ contains any Express middleware
  • models/ contains database model files
    • users.model.ts sets up our user collection for NeDB
  • app.ts configures our Feathers application like we did in the getting started chapter
  • app.hooks.ts registers hooks that apply to every service
  • authentication.ts sets up Feathers authentication system
  • channels.ts sets up Feathers event channels
  • declarations.ts contains TypeScript declarations for our app
  • index.ts loads and starts the application
• test/ contains test files for the app, hooks and services
  • services/ has our service tests
    • users.test.ts contains some basic tests for the users service
  • app.test.ts tests that the index page appears, as well as 404 errors for HTML pages and JSON
  • authentication.test.ts includes some tests that basic authentication works
• .editorconfig is an EditorConfig setting to help developers define and maintain consistent coding styles among different editors and IDEs.
• .gitignore specifies intentionally untracked files which git, GitHub and other similar projects ignore.
• tsconfig.json the TypeScript compiler configuration
• package.json contains information about our NodeJS project like its name or dependencies.
• README.md has installation and usage instructions

src/services/index.ts looks like this:

import { Application } from '../declarations'
import users from './users/users.service'

export default function (app: Application) {
  app.configure(users)
}
import { Application } from '../declarations'
import users from './users/users.service'

export default function (app: Application) {
  app.configure(users)
}
import { Application } from '../declarations.js'
import users from './users/users.service.js'

export default function (app) {
  app.configure(users)
}
import { Application } from '../declarations.js'
import users from './users/users.service.js'

export default function (app) {
  app.configure(users)
}

It uses another configure function exported from src/services/users/users.service.ts. The export from src/services/index.js is in turn used in src/app.ts as:

// ...
import services from './services'

// ...
app.configure(authentication)
// Set up our services (see `services/index.js`)
app.configure(services)
// ...
// ...
import services from './services'

// ...
app.configure(authentication)
// Set up our services (see `services/index.js`)
app.configure(services)
// ...
// ...
import services from './services.js'

// ...
app.configure(authentication)
// Set up our services (see `services/index.js`)
app.configure(services)
// ...
// ...
import services from './services.js'

// ...
app.configure(authentication)
// Set up our services (see `services/index.js`)
app.configure(services)
// ...