git-guide/getting-code.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

2024-05-03 11:22:01 +00:00
# Creating and Cloning a Repository
## Setting up a new repository
2024-05-03 11:22:01 +00:00
Lets look at how you can set up a new remote repository on Gitlab/Github, so you are ready to start committing your code. the easist way is to create a new repository in Gitlab/Github, clone it locally then start adding your files to it. We'll look at this method first.
2024-05-03 10:16:51 +00:00
2024-05-03 11:22:01 +00:00
<details>
<summary>Using Gitlab</summary>
#### Gitlab
2024-05-03 10:16:51 +00:00
2024-05-03 11:22:01 +00:00
- Open Gitlab in your browser and log in
- Now click **new project** on the right hand side of the interface
2024-05-03 10:16:51 +00:00
2024-05-03 11:22:01 +00:00
![Create a New Project](./img/create-new-project.png)
2024-05-03 10:16:51 +00:00
2024-05-03 11:22:01 +00:00
- You'll now be asked what template do you want to use, I recommend a blank project unless your use case fits with the other options
![Select Template for Repo](./img/select-project-type.png)
- Now it's time to give your project a name. You can also set if the project is public or private at this time (although this can be changed later)
![Setup your project](./img/setup-project.png)
- Once done click **create project** at the bottom of the page
- You'll be taken to the next page which shows you a bare bones repository. (It should have a README.md file if you didn't change the setting to create one)
![New repository is now created](./img/project-created.png)
#### Get the project URL
- The next step is to get the URL for the git repository you want to clone. You can do this by going to the green **code** button and clicking it.
- If you intend to commit code back select the SSH URL.
![Get the SSH URL](./img/clone-repo.png)
> If you want to just pull the code down to use locally you can use HTTPS, this is especially useful if you don't have permissions on the repository.
</details>
2024-05-03 11:29:44 +00:00
2024-05-03 11:22:01 +00:00
### Clone the new repository
2024-05-03 11:29:44 +00:00
Now you have the URL you can go back to your terminal and clone the repository.
2024-05-03 11:22:01 +00:00
```bash
git clone git@gitlab.com:ric_harvey/demo-project.git
```
2024-05-03 11:29:44 +00:00
you are now ready to get going committing code! Head over to the [commit.md](./commit.md) file for information on what to do next.
2024-05-03 11:22:01 +00:00
### Adding existing files to a git repository
2024-05-03 11:29:44 +00:00
Now if you have already been working hard and you have files already you can import these files. By following the following instructions. You'll still need that SSH URL you copied.
2024-05-03 11:22:01 +00:00
```bash
2024-05-03 11:29:44 +00:00
cd existing_directory
git init
2024-05-03 11:22:01 +00:00
git remote add origin https://gitlab.com/ric_harvey/demo-project.git
git branch -M main
2024-05-03 11:29:44 +00:00
git add .
git commit -m "first commit"
2024-05-03 11:22:01 +00:00
git push -uf origin main
```
2024-05-03 10:16:51 +00:00
2024-05-03 11:29:44 +00:00
This will now sync all your your files up to the remote repository.
---
##### Follow me for more guides
2024-05-03 10:16:51 +00:00
[<img src="./img/mastodon.png" width="4%">](https://awscommunity.social/@Ric) [<img src="./img/linkedin.png" width="4%">](https://www.linkedin.com/in/richarvey/)