Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/bin/build-preview-site.sh
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ mkdir $JEKYLL_DIR/pages
(TARGET="$PWD/$JEKYLL_DIR/pages" && cd "$PWD/site" && pax -rwlpe . $TARGET)

echo "Copying external README pages"
mkdir -p $JEKYLL_DIR/_includes/readmes
cp $SOURCE_DIR/pages/en/lb4/readmes/*.md $JEKYLL_DIR/pages/readmes/
cp $SOURCE_DIR/pages/en/lb4/readmes/*.md $JEKYLL_DIR/_includes/readmes/

echo "Setting up sidebar(s)"
rm -rf $JEKYLL_DIR/_data/sidebars
Expand Down
118 changes: 118 additions & 0 deletions docs/site/Create-your-first-app copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
lang: en
title: 'Create your first app'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Create-your-first-app.html
summary: Write and run a LoopBack 4 "Hello World" project in TypeScript.
---

## Create Your First App

### Create a new project

The LoopBack 4 CLI scaffolds a new project by setting up the project structure,
configuring the TypeScript, and installing required dependencies.

To create a new project, run the following command and follow the prompts:

```sh
lb4 app
```

Provide the following inputs when prompted:

```sh
? Project name: getting-started
? Project description: Getting started tutorial
? Project root directory: getting-started
? Application class name: StarterApplication
? Select features to enable in the project:
❯◉ Enable eslint: add a linter with pre-configured lint rules
◉ Enable prettier: install prettier to format code conforming to rules
◉ Enable mocha: install mocha to run tests
◉ Enable loopbackBuild: use @loopback/build helpers (e.g. lb-eslint)
◉ Enable editorconfig: add EditorConfig files
◉ Enable vscode: add VSCode config files
◉ Enable docker: include Dockerfile and .dockerignore
◉ Enable repositories: include repository imports and RepositoryMixin
◉ Enable services: include service-proxy imports and ServiceMixin
```

### Starting the project

The generated project includes a built-in `/ping` endpoint for testing.

Start the application:

```sh
cd getting-started
npm install
npm start
```

Open your brower and navigate to:
[http://127.0.0.1:3000/ping](http://127.0.0.1:3000/ping).

### Add a Controller

Next, add a custom [controller](Controller.md). In this example, you’ll create a
simple “Hello World” endpoint.

Run:

```sh
lb4 controller
```

- _Note: If your application is running, press **CTRL+C** to stop it before
running the command._

Respond to the prompts:

```sh
? Controller class name: hello
? What kind of controller would you like to generate? Empty Controller
create src/controllers/hello.controller.ts
update src/controllers/index.ts

Controller hello was now created in src/controllers/
```

### Implement the Controller

Replace the contents of `src/controllers/hello.controller.ts` with the
following:

```ts
import {get} from '@loopback/rest';

export class HelloController {
@get('/hello')
hello(): string {
return 'Hello world!';
}
}
```

### Test the Endpoint

Restart the application:

```sh
npm start
```

Open your browser and navigate to:
[http://127.0.0.1:3000/hello](http://127.0.0.1:3000/hello)

You should see:

```
Hello world!
```

### Code sample

View the complete example project here:
[https://github.com/loopbackio/loopback-next/tree/master/examples/hello-world](https://github.com/loopbackio/loopback-next/tree/master/examples/hello-world)
117 changes: 0 additions & 117 deletions docs/site/Getting-started.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/site/Installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
lang: en
title: 'Installation'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Installation.html
summary: Write and run a LoopBack 4 "Hello World" project in TypeScript.
---

## Prerequisites

Ensure that [Node.js](https://nodejs.org/en/download/) (version 22 or later) is
installed on your machine.

## Install LoopBack 4 CLI

The LoopBack 4 CLI is a command-line tool that scaffolds projects and extensions
by generating the required code. It provides the fastest way to get started with
a LoopBack 4 project while following best practices.

To install the CLI globally, run:

```sh
npm i -g @loopback/cli
```
19 changes: 14 additions & 5 deletions docs/site/sidebars/lb4_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,21 @@ children:
output: 'web, pdf'

- title: 'Getting started'
url: Getting-started.html
output: 'web, pdf'
expand: 'true'

children:
- title: 'Installation'
url: Installation.html
output: 'web, pdf'

- title: 'Create your first app'
url: Create-your-first-app.html
output: 'web, pdf'

- title: 'Project structure'
url: Loopback-application-layout.html
output: 'web, pdf'

- title: 'Inside a LoopBack Application'
url: Inside-LoopBack-Application.html
Expand Down Expand Up @@ -801,10 +814,6 @@ children:
output: 'web, pdf'
children:

- title: 'LoopBack 4 Application Layout'
url: Loopback-application-layout.html
output: 'web, pdf'

- title: 'API docs'
url: apidocs.index.html
output: 'web, pdf'
Expand Down