docs: add project layout ref page #6151
Conversation
agnes512
force-pushed
the
pj-layout
branch
2 times, most recently
from
459ea61 to
12f58c3
Compare
| </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> |
There was a problem hiding this comment.
Update with
npm install
npm install typically does not update dependencies, only install missing ones. npm update is the command to use.
agnes512
force-pushed
the
pj-layout
branch
2 times, most recently
from
3df9d54 to
57c0cf3
Compare
There was a problem hiding this comment.
Nice contents LGTM.
A few suggestions:
- Should we consider adding the configure files like
tsconfig.json,/.vscode? - For the code reference, maybe we can link to the todo example? Or add a note before the table saying all the files could be found in todo example.
|
@jannyHou Added an entry for the |
| these sub-directories: | ||
|
|
||
| - `src` - Node application scripts and configuration files. | ||
| - `public` - Client JavaScript, HTML, and CSS files. |
There was a problem hiding this comment.
Client side assets (JavaScript, HTML, and CSS) for the default home page.
There was a problem hiding this comment.
Maybe we should mention dist - which contains transpiled JavaScript code generated by npm run build.
There was a problem hiding this comment.
I added dist folder under Top level app directory, PTAL.
| directory_. Within this directory the standard LoopBack 4 project structure has | ||
| these sub-directories: | ||
|
|
||
| - `src` - Node application scripts and configuration files. |
There was a problem hiding this comment.
TypeScript source code
| <td>A sub-directory for all repository files. See <a href="Repository.html">Repository</a>.</td> | ||
| <td> </td> | ||
| </tr> | ||
| <tr> |
There was a problem hiding this comment.
Should mention src/__tests__?
|
|
||
| LoopBack 4 project files and directories are in the _application root | ||
| directory_. Within this directory the standard LoopBack 4 project structure has | ||
| these sub-directories: |
There was a problem hiding this comment.
We should mention the project layout was created by lb4 application command and new artifacts can be added by other lb4 commands or manually by application developers.
There was a problem hiding this comment.
👍 I added CLI links to each artifact.
| permalink: /doc/en/lb4/Project-layout-reference.html | ||
| --- | ||
|
|
||
| LoopBack 4 project files and directories are in the _application root |
There was a problem hiding this comment.
We have two types of projects:
- Application project (for LB4 applications)
- Extension project (for LB4 extension modules)
Should we make it explicit this layout is for LB4 applications?
There was a problem hiding this comment.
Sure, I can change the title as well if we need another page for extension project.
agnes512
force-pushed
the
pj-layout
branch
2 times, most recently
from
0946603 to
5889c94
Compare
There was a problem hiding this comment.
Thanks @agnes512. I have a few minor comments.
I'm not sure if we also want to cover files, e.g. dockerfile, vs code related files, that are generated depends the options users select when scaffolding the application. But either way, I'm happy to have this PR land the way it is and iterate on it.
| @@ -0,0 +1,129 @@ | |||
| --- | |||
| lang: en | |||
| title: 'LoopBack 4 Application Layout Reference' | |||
Signed-off-by: Agnes Lin <[email protected]>
Closes #4847. See LB3 version for reference.
Checklist
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈