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
+76-36Lines changed: 76 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,69 +4,109 @@ title: Getting Started
4
4
description: Get started with Defang.
5
5
---
6
6
7
-
8
7
# Getting Started
9
8
10
9
11
-
###Install the CLI
10
+
## Install the CLI
12
11
13
12
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
13
15
-
### Authenticate with Defang
14
+
##Generate a project
16
15
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:
16
+
```
17
+
$ defang generate nodejs-http
18
+
```
18
19
19
-
```bash
20
-
defang login
20
+
You should see the following prompt:
21
21
```
22
+
? What folder would you like to create the project in?
23
+
```
24
+
Type in the name of the folder you'd like to use for your new project and press ENTER.
22
25
23
-
:::info
24
-
To learn more about how authentication works in defang, check out the [authenticating page](./authenticating.md).
25
-
:::
26
+
I'll type `"welcome-to-defang"`. Now, you'll see the following output:
26
27
27
-
### Agree to the terms of service
28
+
```
29
+
? What folder would you like to create the project in? welcome-to-defang
30
+
* Fetching sample from the Defang repository...
31
+
* Writing files to disk...
32
+
- .github/
33
+
- .github/workflows/
34
+
- .github/workflows/deploy.yaml
35
+
- README.md
36
+
- app/
37
+
- app/Dockerfile
38
+
- app/main.js
39
+
- compose.yaml
40
+
* Code generated successfully in folder welcome-to-defang
41
+
42
+
Check the files in your favorite editor.
43
+
To deploy the service, do `cd welcome-to-defang` and
44
+
45
+
defang compose up
46
+
```
28
47
29
-
Before you can deploy code you should read and agree to our the terms of service. You can do this by running:
48
+
Now, navigate to the folder you just created:
30
49
31
-
```bash
32
-
defang terms
50
+
```
51
+
$ cd welcome-to-defang
33
52
```
34
53
35
-
### Build and Deploy Services
54
+
You can open the folder in your favorite editor and see the files that were generated for you:
55
+
* The `app` folder contains the code for your service.
56
+
* The `Dockerfile` is used to build the container image for your service.
57
+
* The `compose.yaml` file is used to define the services you want to deploy.
36
58
37
-
Defang supports various ways of creating and deploying services to the cloud. The following tutorials dive into each one in more detail:
59
+
## Deploy to the playground
38
60
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)
61
+
Go back to your shell and type the following:
43
62
63
+
```
64
+
$ defang up
65
+
```
44
66
45
-
### Monitor Services
67
+
If you have not used defang before, you'll be prompted to log in.
46
68
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.
69
+
```
70
+
! Please log in to continue.
71
+
Please visit http://127.0.0.1:49154 and log in. (Right click the URL or press ENTER to open browser)
72
+
```
48
73
49
-
- From the CLI:
74
+
:::info
75
+
To learn more about how authentication works in defang, check out the [authenticating page](/docs/getting-started/authenticating).
76
+
:::
50
77
51
-
```tsx
52
-
defangtail--nameservice1
53
-
```
78
+
When I do this, I see the following output:
54
79
55
-
-FromtheDefangPortal:
80
+
```
81
+
* Uploading build context for app
82
+
* Deploying service app
83
+
* Monitor your services' status in the defang portal
84
+
- https://portal.defang.dev/service/app
85
+
* Tailing logs for deployment ID o59k89vk3qc8 ; press Ctrl+C to detach:
86
+
* Press V to toggle verbose mode
87
+
2024-09-19T10:50:53.572443-07:00 cd Update started for stack jordanstephens-prod1
88
+
2024-09-19T10:51:05.536299-07:00 cd Update succeeded in 11.99769745s ; provisioning...
89
+
2024-09-19T10:51:39.419693-07:00 app Server running at http://0.0.0.0:3000/
90
+
* Service app is in state DEPLOYMENT_COMPLETED and will be available at:
6.[Deploy using Pulumi](/docs/tutorials/deploy-using-pulumi)
69
111
70
-
:::info
71
-
Ifyouareusing [composefiles](../concepts/compose.md) todefineyourservices, youcanadd/removeservices, makechangestocode, etc. Whenyourun`defang compose up`, theupdatewillbediffedagainstthecurrentstateandanynecessarychangeswillbeappliedtomakethecurrentstatematchthedesiredstate.
72
-
:::
112
+
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