Skip to content

Commit 4373a41

Browse files
adds more in-depth guide for initializing project
1 parent 09967cb commit 4373a41

1 file changed

Lines changed: 52 additions & 1 deletion

File tree

docs/pages/getting-started/initialize-project.mdx

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,60 @@ DevSpace's initialization wizard will walk you through the setup of the project
4545
php
4646
python
4747
```
48-
Choose the language of your quickstart project. This will determine the correct [devImage](https://devspace.sh/docs/configuration/dev/modifications/dev-image)
48+
Choose the language of your quickstart project. This will determine the correct [devImage](/configuration/dev/modifications/dev-image).
4949

50+
```
51+
? How do you want to deploy this project? [Use arrows to move, type to filter]
52+
> helm
53+
kubectl
54+
kustomize
55+
```
56+
Now, you can pick your preferred way to deploy the project. For now, choose [`helm`](/configuration/deployments/helm/), you can always mix and match later.
57+
58+
```
59+
? Is this a DevSpace Quickstart project? [Use arrows to move, type to filter]
60+
> Yes
61+
No
62+
```
63+
DevSpace can detect when you're using a quickstart project.
64+
65+
```
66+
? Do you want to develop this project with DevSpace or just deploy it? [Use arrows to move, type to filter] [Use arrows to move, type to filter]
67+
> I want to develop this project and my current working dir contains the source code
68+
I just want to deploy this project
69+
```
70+
When initializing DevSpace, you can ask it to monitor the source code for changes, or to only set up what's needed for deploying your application.
71+
Since we want to see how DevSpace handles the entire development cycle, choose the first option here.
72+
73+
```
74+
? How should DevSpace build the container image for this project? [Use arrows to move, type to filter]
75+
> Use this existing Dockerfile: ./Dockerfile
76+
Use a different Dockerfile (e.g. ./backend/Dockerfile)
77+
Use alternative build tool (e.g. jib, bazel)
78+
Skip / I don't know
79+
```
80+
DevSpace expects to receive instructions, how to containerize the source code. For the quickstart projects, a Dockerfile is provided in the root folder.
81+
82+
```
83+
? If you were to push any images, which container registry would you want to push to? [Use arrows to move, type to filter]
84+
> Skip Registry
85+
Use hub.docker.com
86+
Use GitHub image registry
87+
Use other registry
88+
```
89+
For local development and quick feedback cycles, we recommend to skip pushing images to any registry.
5090

91+
```
92+
done Project successfully initialized
93+
info Configuration saved in devspace.yaml - you can make adjustments as needed
94+
95+
You can now run:
96+
1. devspace use namespace - to pick which Kubernetes namespace to work in
97+
2. devspace dev - to start developing your project in Kubernetes
98+
99+
Run `devspace -h` or `devspace [command] -h` to see a list of available commands and flags
100+
```
101+
Congratulations! You have succesfully initialized your first DevSpace project! 🎉
51102

52103
After running `devspace init`, you will see 3 changes in your project:
53104
1. New file `devspace.yaml` (tells DevSpace how this project should be build, deployed, and developed)

0 commit comments

Comments
 (0)