Skip to content

This is a reference for future projects on how to setup your iOS project.

License

Notifications You must be signed in to change notification settings

maryshkamy/Karazhan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Karazhan


"Karazhan is an abandoned ancient tower located in Deadwind Pass. Karazhan is notable for its famous occupant, the last Guardian of Tirisfal, Medivh." WoW Head


This is a reference for future projects on how to set up your iOS project. Like a library that contains many books to guide you in a specific subject.


📋 Requirements

This project requires Homebrew to be installed on your machine in order to execute some Makefile commands. To install Homebrew, open a new Terminal window. Type the above command and press enter to install it.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

• Configure your Git username/email

  1. Open Terminal.
  2. Set your username:
git config --global user.name "Your Name"
  1. Set your email address:
git config --global user.email [email protected]

🔒 Authentication

"The Secure Shell Protocol (SSH) is a cryptographic network protocol for operating network services securely over an unsecured network. Its most notable applications are remote login and command-line execution." Secure Shell on Wikipedia

You can access and write data in repositories on GitHub.com using SSH (Secure Shell Protocol). When you connect via SSH, you authenticate using a private key file on your local machine.

For more information about Connect with SSH, see Authentication / Connect with SSH on GitHub Docs.

• Generate a new SSH key

  1. Open Terminal.
  2. Paste the text below, replacing the email used in the example with your GitHub email address.
ssh-keygen -t ed25519 -C "[email protected]"

For more information about it, see Generate a new SSH key on GitHub Docs.

• Adding your SSH key to the ssh-agent

  1. Open Terminal.
  2. Start the ssh-agent in the background.
eval "$(ssh-agent -s)"
  1. Modify your ~/.ssh/config file to automatically load keys into the ssh-agent and store passphrases in your keychain. 3.1. If the file doesn't exist, create the file.

    touch ~/.ssh/config
    

    3.2. Open your ~/.ssh/config file.

    open ~/.ssh/config
    

    3.3. Modify the file to contain the following lines.

    Host github.com
      AddKeysToAgent yes
      UseKeychain yes
      IdentityFile ~/.ssh/id_ed25519
    
  2. Add your SSH private key to the ssh-agent and store your passphrase in the keychain.

ssh-add --apple-use-keychain ~/.ssh/id_ed25519

For more information about it, see Adding your SSH key to the ssh-agent on GitHub Docs.

• Adding a new SSH key to your account

  1. OOpen Terminal.
  2. Copy the SSH public key to your clipboard.
pbcopy < ~/.ssh/id_ed25519.pub
  1. In the upper-right corner of any page on GitHub, click your profile photo, then click Settings.
  2. In the "Access" section of the sidebar, click SSH and GPG keys.
  3. Click New SSH key.
  4. In the "Title" field, add a descriptive label for the new key.
  5. In the "Key" field, paste your public key.
  6. Click Add SSH key.

For more information about it, see Adding a new SSH key to your account on GitHub Docs.


⚙️ Setup

After cloning it, on the project directory run the setup command using the terminal:

make setup

Work in progress...


🧰 Optional Setup

⚠️ The following setup is completely optional. ⚠️ Please use only one of these setups if any or all of them make sense to you as you develop.

  • Oh My ZSH is an open source, community-driven framework for managing your ZSH configuration.
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
  • XOPEN is a short and useful script to open your Xcode projects from your terminal window.
curl -L https://raw.github.com/paulomendes/xopen/master/install.sh | sh

About

This is a reference for future projects on how to setup your iOS project.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published