Development environment setup

Hello prospective carrot! 👋

Thanks for considering collaborating with us in making Carrot the best JavaScript library for AI in the world 🌍

To help you get started we've curated a list of guides and steps to follow. Please take some time to read them and feel free to reach out with any questions you might have: [email protected]

1. Opening the terminal

💡 Why it's useful

To access open source code, edit code, run it, and do almost anything related to development you'll be using the terminal.

📌 More info

Terminals, also known as command lines or consoles, allow us to send simple text commands to our computer to do things like navigate through a directory (folder) or copy a file, and form the basis for more complex automation and programming skills.

Mac

📜 How to use terminal on mac

Windows

📜 How do I open terminal in windows?

Ubuntu Linux

📜 How do I open a terminal?

*	🎓 Learn more	*
-	🎥 Beginner's Guide to the Bash Terminal -> OS: Linux	-

2. Generating SSH Keys

💡 Why it's useful

SSH Keys are a good way to connect to things through your terminal

📌 More info

SSH Keys are like passwords, don't share them!

Mac & Linux

📜 Generate an SSH key

3. Adding your SSH Keys to GitHub

💡 Why it's useful

TBD

📌 More info

TBD

📜 Adding a new SSH key to your GitHub account

---

🤔 Having trouble? Make sure to choose your operating system

4. Installing Git

💡 Why it's useful

Git helps you save your code changes and makes sure you can go back to a previous version if things go wrong

📌 More info

Git is a version control system. Version control systems are a category of software tools that help a software team manage changes to source code over time. Version control software keeps track of every modification to the code in a special kind of database. source (adapted)

Ubuntu Linux

🔍 Use "Installing Git with Default Packages"

📜 Install Git on Ubuntu 18.04

*	🎓 Learn more	*
-	▶️ How-to Git: Interactive Git Tutorials	-

5. Configuring Git

💡 Why it's useful

TBD

📌 More info

TBD

🔍 Use "Setting your git username for every repository"

📜 Setting your git username

📜 Setting your git email

To check that it worked copy this into your terminal

Linux

cat ~/.gitconfig

Windows

get-content TBD

6. Add a custom git configuration

💡 Why it's useful

TBD

📌 More info

TBD

We'll be editing the .gitconfig file directly to save some typing

1. Copy this into your terminal

   git config --edit --global

2. Copy this on a newline immediately after your last [user] setting

   [push]
       default = simple
   [core]
       autocrlf = input
   [alias]
       s = status -s
       lg = log --oneline --decorate --graph
       g = grep --break --heading --line-number
   [pull]
       rebase = true
   

Extra

📜 Extended config settings

7. Forking & cloning 🥕 Carrot from Github

💡 Why it's useful

TBD

📌 More info

TBD

1. Read this: 📜 How-to: fork a repo

2. When cloning use your fork URL: [email protected]:YOUR-USERNAME/carrot.git

8. Setting 🥕 Carrot as the upstream git repository

💡 Why it's useful

This keeps your local copy of the carrot code synced with the latest changes accepted into the official repository. Without syncing your copy with upstream, changes that you make can conflict with other people's work which means you'll have to manually merge all of their changes and figure out which of yours to keep.

📌 More info

If this was successful you should see upstream when you run git remote -v

1. Go into the new folder carrot using cd carrot/

2. Set 🥕 Carrot as your upstream by copying this into your terminal

   git remote add upstream [email protected]:liquidcarrot/carrot.git

3. Copy this into your terminal

   git remote -v

4. Make sure that you see upstream in the list of remotes

9. Installing Node.js + NPM

💡 Why it's useful

TBD

📌 More info

Node.js is the backend version of JavaScript which is traditionally a language used for web-browser animations and other visual functionality on the "frontend". Today, Node.js is used for just about everything including front-end development itself. NPM is the package manager for Node.js which means you can use it import tools to make your development easier.

Ubuntu Linux

🔍 Use "Install Node.js from the NodeSource repository"

📜 How to install nodejs on Ubuntu 18.04

MacOS

🔍 Click "macOS Installer, which has the apple logo"

🔗 Node.js Official Download page

10. Installing Visual Studio Code IDE

💡 Why it's useful

TBD

📌 More info

An Integrated Development Environment (IDE) is a program that facilitates software development by various software-related tasks to be done in a single application. Most include debugging support, version control, syntax highlighting, code browsing features, and even an integrated terminal to run commands. source (adapted)

Ubuntu Linux

📜 How to install visual studio code on Ubuntu 18.04

MacOS

🔍 Click "Mac, which has the apple logo"

🔗 VSCode Official Download page

*	🎓 Learn more	*
-	🎥 Quick intro to VSCode IDE -> OS: Linux	-