Skip to content

m70v/Sportify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 

Repository files navigation

SPORTIFY

Sportify is built for one reason, to get more people outside. Whether you're cycling coastal roads at sunrise, hiking through mountain wadis, or swimming open water with a group of strangers who become friends, we believe the outdoors is better when you have the right people and the right information to explore it with confidence. We built the routes, the events, and the community tools that make that easier, verified by real athletes who know these places personally.


How to use this repo and git in general

1- download git and setup your environment

first you need to install git, search for it and install it like any other program.

after that you will need to setup your identity, to do this you can run these commands in your terminal:

git config --global user.name "Your name"
git config --global user.email "your email"

2- cloning the repo

you will need to do this once only, this will download all the files of the project to your computer. by default the files will be downloaded in your currently working directory. to change that you can just use cd /your/prefered/directory and then clone the repo. or you can just type the directory after the cloning command.

this is the command that you will use to clone the repo:

git clone https://github.com/m70v/Sportify.git

this command to clone the repo to a specific directory:

git clone https://github.com/m70v/Sportify.git /path/to/your/directory

3- important thing to do before starting your work

sometimes our team mates will push code to the repo which will make your local version outdated, and that can cause conflicts. to avoid that make sure that you run this command everytime before you start working, or when you know that the code has been updated.

git pull

make sure to use this command inside the directory where your repo is.

4- create your own version of the code

in git there is something called branch, which is like copies of the main codebase, and with that you can create and edit your own version of the code without effecting others and creating a mess. after you are done with your edits you can merge the code to the main codebase.

by default, the main branch is usually called master or main (in our case its master), so you will need to create your own branch with this command

git checkout -b your-branch-name

usually branches are names after the feature that you are trying to add, tho you can use the same branch for every edit, and you can create as many branches as you want. each branch will have their own files and edits unless merged with master(the main branch).

5- adding changes

after you have made your edits you would want them to be saved by git, to do that you can run this command:

git add .
git commit -m "a discription of what you did"

and if you added new files they are not going to be tracked by default, so you will need to run git add . each time for git to track them:

also its better to do a commit after every small changes.

6- pushing your edits to github

now after you have done your edits, you would want them to appear on github, to do that you should run this command:

git push origin your-branch-name

also you might get a message every time asking for username and password, that part is a bit tricky so its best to follow this guide

7- opening a pull request

pull request is basically a request to apply your edits that you made on your branch, to the main branch (master).

to do that you will use your browser:

1- open the repo in github.

2- switch to your branch .

3- you should see a prompt to open a pull request for your branch, click it and write a discription of what you did.

4- someone from the team should review it and then approve the pull request, after that your changes will appear in the main branch.


hope that was helpful, you can always check youtube or git documentations if you were confused about any step.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors