docs: add project layout ref page

Signed-off-by: Agnes Lin <[email protected]>
loopbackio · Aug 20, 2020 · 12f58c3 · 12f58c3
1 parent 7d9d6bf
commit 12f58c3
Show file tree

Hide file tree

Showing 2 changed files with 122 additions and 0 deletions.
diff --git a/docs/site/Project-layout-reference.md b/docs/site/Project-layout-reference.md
@@ -0,0 +1,118 @@
+---
+lang: en
+title: 'Project Layout Reference'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript
+sidebar: lb4_sidebar
+permalink: /doc/en/lb4/Project-layout-reference.html
+---
+
+LoopBack 4 project files and directories are in the _application root
+directory_. Within this directory the standard LoopBack project structure has
+these sub-directories:
+
+- `src` - Node application scripts and configuration files.
+- `public` - Client JavaScript, HTML, and CSS files.
+- `definitions` - API and product definition YAML files (**IBM API Connect
+  only**).
+
+{% include tip.html content="By LoopBack naming conventions, artifacts such as models are grouped under their sub-directories. Also, with LoopBack artifact generators, they create class names in CamelCase and file names are in snake-case. For example, if you create a model named `MyUserModel` with the model generator, it creates files `my-user.model.ts` under `src/models`. See [Naming Convention](Command-line-interface.md#naming-convention) for more information.
+" %}
+
+<table style="font-size: 90%;">
+  <thead>
+    <tr>
+      <th width="200">File or directory</th>
+      <th>Description</th>
+      <th width="180">How to access in code</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <th colspan="3" style="text-align: center; background-color: #bfbfbf;">Top-level application directory</th>
+    </tr>
+    <tr>
+      <td><code>/node-modules</code> directory</td>
+      <td>Contains Node packages as specified as dependencies in <code>package.json</code>. Update with <code>npm install</code>.</td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <td>
+          <code><a href="">package.json</a></code>
+      </td>
+      <td>
+        Standard npm package specification. Use it to set up package dependencies, among other things. This file must be in the application root directory. See <a href="https://docs.npmjs.com/files/package.json"><code>npm-package.json</code> for information.</a>.
+      </td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <td><code>README.md</code></td>
+      <td>Stub file for internal documentation.</td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <th colspan="3" style="text-align: center; background-color: #bfbfbf;">/src directory - Node application files</th>
+    </tr>
+    <tr>
+      <td><code>/controllers</code> directory</td>
+      <td>A sub-directory for all controller files. See <a href="Controller.html">Controller</a>.</td>
+      <td>>&nbsp;</td>
+    </tr>
+    <tr>
+      <td><code>/datasources</code> directory</td>
+      <td>A sub-directory for all dataSource files. See <a href="DataSource.html">DataSource</a>.</td>
+      <td>>&nbsp;</td>
+    </tr>
+    <tr>
+      <td><code>/models</code> directory</td>
+      <td>A sub-directory for all model files. See <a href="Model.html">Model</a>.</td>
+      <td>>&nbsp;</td>
+    </tr>
+    <tr>
+      <td><code>/repositories</code> directory</td>
+      <td>A sub-directory for all repository files. See <a href="Repository.html">Repository</a>.</td>
+      <td>>&nbsp;</td>
+    </tr>
+    <tr>
+      <td><code>application.ts</code></td>
+      <td>Main application program file. A central registry file for inversion of control and dependency injection. See <a href="Application.html">Application</a>.</td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <td><code>index.ts</code></td>
+      <td>A script that initializes and runs the application.</td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <td><code>migrate.ts</code></td>
+      <td>A script to run database migration. See <a href="Database-migrations.html">Database Migrations</a>.</td>
+      <td><code>npm run build && npm run migrate</code></td>
+    </tr>
+    <tr>
+      <td><code>openapi-spec.ts</code></td>
+      <td>A script that exports the OpenAPI spec from the application.</td>
+      <td><code>npm run build && npm run openapi-spec</code></td>
+    </tr>
+    <tr>
+      <td><code>sequence.ts</code></td>
+      <td>A file where to define a series of steps to control how a specific type of `Server`
+      responds to incoming requests. See <a href="Sequence.html">Sequence</a>.</td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <th colspan="3" style="text-align: center; background-color: #bfbfbf;">/public directory - Client application files</th>
+    </tr>
+    <tr>
+      <td><code>index.html</code></td>
+      <td>An example LoopBack front page.</td>
+      <td>N/A</td>
+    </tr>
+    <tr>
+      <td>Others</td>
+      <td>Add your HTML, CSS, client JavaScript files.</td>
+      <td>&nbsp;</td>
+    </tr>
+    <tr>
+      <th colspan="3" style="text-align: center; background-color: #bfbfbf;">/common directory - shared application files</th>
+    </tr>
+  </tbody>
+</table>
diff --git a/docs/site/sidebars/lb4_sidebar.yml b/docs/site/sidebars/lb4_sidebar.yml
@@ -604,6 +604,10 @@ children:
   output: 'web, pdf'
   children:
 
+  - title: 'Project Layout Reference'
+    url: Project-layout-reference.html
+    output: 'web, pdf'
+
   - title: 'Examples'
     url: Examples.html
     output: 'web, pdf'