You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/getting-started.md
+78-36Lines changed: 78 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,70 +3,112 @@ sidebar_position: 200
3
3
title: Getting Started
4
4
description: Get started with Defang.
5
5
---
6
-
6
+
import { OpenInNew } from "@mui/icons-material";
7
7
8
8
# Getting Started
9
9
10
10
11
-
###Install the CLI
11
+
## Install the CLI
12
12
13
13
First, you'll need to install the Defang CLI. The CLI is the primary way to interact with Defang. It allows you to create, deploy, and manage your services. You can find the [different installation methods here](./installing.md).
14
14
15
-
### Authenticate with Defang
15
+
##Generate a project
16
16
17
-
To do pretty much anything with Defang, you'll need to authenticate with the platform. You can do this by running the following command:
17
+
```
18
+
$ defang generate nodejs-http
19
+
```
18
20
19
-
```bash
20
-
defang login
21
+
You should see the following prompt:
21
22
```
23
+
? What folder would you like to create the project in?
24
+
```
25
+
Type in the name of the folder you'd like to use for your new project and press ENTER.
22
26
23
-
:::info
24
-
To learn more about how authentication works in defang, check out the [authenticating page](./authenticating.md).
25
-
:::
27
+
I'll type `"welcome-to-defang"`. Now, you'll see the following output:
26
28
27
-
### Agree to the terms of service
29
+
```
30
+
? What folder would you like to create the project in? welcome-to-defang
31
+
* Fetching sample from the Defang repository...
32
+
* Writing files to disk...
33
+
- .github/
34
+
- .github/workflows/
35
+
- .github/workflows/deploy.yaml
36
+
- README.md
37
+
- app/
38
+
- app/Dockerfile
39
+
- app/main.js
40
+
- compose.yaml
41
+
* Code generated successfully in folder welcome-to-defang
42
+
43
+
Check the files in your favorite editor.
44
+
To deploy the service, do `cd welcome-to-defang` and
45
+
46
+
defang compose up
47
+
```
28
48
29
-
Before you can deploy code you should read and agree to our the terms of service. You can do this by running:
49
+
Now, navigate to the folder you just created:
30
50
31
-
```bash
32
-
defang terms
51
+
```
52
+
$ cd welcome-to-defang
33
53
```
34
54
35
-
### Build and Deploy Services
55
+
You can open the folder in your favorite editor and see the files that were generated for you:
56
+
* The `app` folder contains the code for your service.
57
+
* The `Dockerfile` is used to build the container image for your service.
58
+
* The `compose.yaml` file is used to define the services you want to deploy.
36
59
37
-
Defang supports various ways of creating and deploying services to the cloud. The following tutorials dive into each one in more detail:
60
+
## Deploy to the playground
38
61
39
-
1.[Deploy an outline using AI](../tutorials/generate-new-code-using-ai.mdx)
40
-
2.[Build and deploy your code](../tutorials/deploy-code-compose.mdx)
4.[Deploy using Pulumi](../tutorials/deploy-using-pulumi.mdx)
62
+
Go back to your shell and type the following:
43
63
64
+
```
65
+
$ defang up
66
+
```
44
67
45
-
### Monitor Services
68
+
If you have not used defang before, you'll be prompted to log in.
46
69
47
-
By default, all the output (stdout and stderr) from your app is logged. You can view these logs in real-time. You can view logs for all your services, one service, or even one specific deployment of a service.
70
+
```
71
+
! Please log in to continue.
72
+
Please visit http://127.0.0.1:49154 and log in. (Right click the URL or press ENTER to open browser)
73
+
```
48
74
49
-
- From the CLI:
75
+
:::info
76
+
To learn more about how authentication works in defang, check out the [authenticating page](/docs/getting-started/authenticating).
77
+
:::
50
78
51
-
```tsx
52
-
defangtail--nameservice1
53
-
```
79
+
When I do this, I see the following output:
54
80
55
-
-FromtheDefangPortal:
81
+
```
82
+
* Compressing build context for app at /Users/jordan/welcome-to-defang/app
83
+
* Uploading build context for app
84
+
* Deploying service app
85
+
* Monitor your services' status in the defang portal
86
+
- https://portal.defang.dev/service/app
87
+
* Tailing logs for deployment ID o59k89vk3qc8 ; press Ctrl+C to detach:
88
+
* Press V to toggle verbose mode
89
+
2024-09-19T10:50:53.572443-07:00 cd Update started for stack jordanstephens-prod1
90
+
2024-09-19T10:51:05.536299-07:00 cd Update succeeded in 11.99769745s ; provisioning...
91
+
2024-09-19T10:51:39.419693-07:00 app Server running at http://0.0.0.0:3000/
92
+
* Service app is in state DEPLOYMENT_COMPLETED and will be available at:
6.[Deploy using Pulumi](/docs/tutorials/deploy-using-pulumi)
69
113
70
-
:::info
71
-
Ifyouareusing [composefiles](../concepts/compose.md) todefineyourservices, youcanadd/removeservices, makechangestocode, etc. Whenyourun`defang compose up`, theupdatewillbediffedagainstthecurrentstateandanynecessarychangeswillbeappliedtomakethecurrentstatematchthedesiredstate.
72
-
:::
114
+
Choose the direction that seems the most interesting. If you have any questions, join the [Defang Discord](https://discord.gg/defang) and we'll be happy to help you out.
0 commit comments