DEV Community

loading...
Cover image for Convert existing local project into git project

Convert existing local project into git project

dailydevtips1 profile image Chris Bongers Originally published at daily-dev-tips.com ・2 min read

I'm pretty sure we've all been here at some stage, you have a local folder with a quick project. The project soon turns out to be pretty useful so you actually wanted version control on it.

So how do we convert this folder into a git versioned project and even push it to GitHub?

First of all, we should have this local project somewhere on our computer, for me, it's a folder called local-gitter which contains a very basic website.

Local gitter folder structure

Creating the GitHub project

Now let's head over to GitHub and create a new empty project.

GitHub new project

On the next screen, you can fill out the name of your project, and add a description.

You can optionally choose to create it with a readme or gitignore file.

GitHub new repo settings

Once we have this repository, it's important to note the URL.

GitHub repo url

Pushing our existing files to this repository

Now let's open our favorite terminal and follow these steps

  • Navigate to the project folder.
  • git init (start new git project)
  • touch .gitignore (add ignore the file, add files you don't want in git here)
  • git add . or git add ${all relevant files} (the dot adds everything, else add all files you want in git)
  • git commit -m "first message" (Make it a good message)
  • git remote add origin git@github.com:rebelchris/local-gitter.git (change with your URL)
  • git push -u origin master

Note: The gitignore file is super useful to not push stuff like node_modules for instance, always make sure to add these in the gitignore.

And we are done, now if we head over to GitHub we should see all the files we just committed.

GitHub with all our files

Thank you for reading, and let's connect!

Thank you for reading my blog. Feel free to subscribe to my email newsletter and connect on Facebook or Twitter

Discussion (10)

pic
Editor guide
Collapse
madza profile image
Madza • Edited

Simple and straight forward πŸ˜‰

Tho, I kinda miss creating a new repo without leaving a terminal:
1) smth like git repo create <repo name>
2) asks to login to GitHub if not already
3) asks some questions like setting repo to public/private, create readme, gitignore, add a license, add a description, similar like you would do when running npm init
4) generates a remote URL and adds it to the project automatically

An idea for devs or I miss something and there already is a way?

Collapse
dailydevtips1 profile image
Chris Bongers Author

I think the GitHub CLI comes with that to be honest!
I haven't used it because most my projects for work need a bigger setup than it can do.

Let me try that out and write it down for you

cli.github.com/

Collapse
madza profile image
Madza • Edited

You are right, gh repo create [<name>] [flags] πŸ‘
Git CLI docs reference πŸ“š Thanks πŸ˜‰

Collapse
rahxuls profile image
Rahul

Simple and awesome

Collapse
dailydevtips1 profile image
Chris Bongers Author

Thanks Rahul, one of the most used commands I think on my terminal

Collapse
rahxuls profile image
Rahul

Yea i think this will become the most used command for me tooπŸ˜‚. I want to learn git fully 😭

Collapse
mrsid profile image
MrSid

Much needed πŸ”₯πŸ”₯

Collapse
dailydevtips1 profile image
Chris Bongers Author

Thank you MrSid

Collapse
ibtsamilahi09 profile image
Ibtasam Hassan

wow Clean & simple.

Collapse
dailydevtips1 profile image
Chris Bongers Author

Glad you like the article Ibtasam