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: README.md
+58-8Lines changed: 58 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,18 +80,68 @@ The detailed step-by-step instructions for each of these areas are provided belo
80
80
81
81
This section outlines all the necessary steps to get your project environment, authentication, cloud resources, and CI/CD pipeline fully configured.
82
82
83
-
**1. Clone the Repository:**
83
+
Follow these steps:
84
84
85
-
- Obtain a copy of this template project on your local machine.
85
+
**1. Create a New Private Repository on GitHub:**
86
86
87
-
```bash
88
-
# [TODO: Add specific cloning instructions if this is a template repository on GitHub]
89
-
# Example:
87
+
* Log in to your GitHub account.
88
+
* Click the `+` icon in the top-right corner and select `New repository`.
89
+
* Choose a descriptive name for your new repository (e.g., `my-dbt-prefect-project`).
90
+
***Crucially, select `Private` visibility.** This is the most important step for keeping your version confidential.
91
+
***Important:****Do NOT** initialize the repository with a README, .gitignore, or license file when creating it on GitHub. You want an empty repository to push the template code into.
92
+
* Click `Create repository`.
93
+
* On the next page ("Quick setup"), copy the repository URL (either HTTPS or SSH). You will need this in Step 3. It will look something like `https://github.com/<YourUsername>/<your-repo-name>.git` or `git@github.com:<YourUsername>/<your-repo-name>.git`.
* Navigate to the directory where you want to store your project locally.
99
+
* Clone this template repository using its public URL. Replace `<your-local-directory-name>` with the name you want for your local folder (it can be the same as your GitHub repo name).
* Navigate into the newly created local directory:
104
+
```bash
105
+
cd<your-local-directory-name>
106
+
```
107
+
108
+
**3. Connect Your Local Clone to Your New Private Repository:**
109
+
110
+
* Now, you need to tell your local Git repository to point to your new *private* repository on GitHub instead of the original public template. Replace `<your_private_repo_url>` with the URL you copied in Step 1.
***(Optional but Recommended)** Verify that the remote URL has been updated correctly:
123
+
```bash
124
+
git remote -v
125
+
```
126
+
*(The output should now show your private repository's URL for `origin`)*
127
+
128
+
**4. Push the Code to Your Private Repository:**
129
+
130
+
* Push the cloned code (including the template's history) from your local machine up to your new private repository on GitHub. The `-u` flag sets up tracking, making future pushes/pulls easier. (Use `main` or `master` depending on the default branch name of this template).
131
+
```bash
132
+
# If the default branch is 'main'
133
+
git push -u origin main
134
+
135
+
# If the default branch is 'master'
136
+
# git push -u origin master
137
+
```
138
+
* You may be prompted for your GitHub username and password (or token) if using HTTPS.
139
+
140
+
**Completion:**
141
+
142
+
You're all set! Your local directory `<your-local-directory-name>` is now connected to your private GitHub repository (`<YourUsername>/<your-repo-name>`). You have an independent copy of the template code to modify and build upon privately.
143
+
144
+
**Remember:** Always handle secrets (API keys, passwords, etc.) securely using tools like GitHub Actions Secrets, environment variables, or dedicated secrets managers. **Do not commit secrets directly into your repository's files.**
0 commit comments