Skip to content

Latest commit

 

History

History
120 lines (64 loc) · 6.46 KB

firststeps.md

File metadata and controls

120 lines (64 loc) · 6.46 KB

First Steps

The Big Picture

Welcome to the first steps for becoming part of PlanetFarms program at Earthowned! These first steps are a process to prove that you have learned the foundational skills before you can progress to working on harder projects with larger teams. Consider this to be the interview for the program.

If you are selected after completing the steps, you will be officially invited to join the PlanetFarms team!

The Steps

Social coding is a huge part of any open source and collaborative project, and the Open Learning Exchange (OLE) is no different. In the following series of steps, you will learn about Markdown, Docker, Git, GitHub, GitHub issues, GitHub pull requests, etc. You will also be introduced to OLE’s digital library that hosts the learning materials – Planet.

Because these steps are simple, we expect high-quality work, which may take a longer time. We want to see that you are capable of using or learning how to use these tools (writing good GitHub issues, creating pull requests, using Markdown and Docker, etc.). These steps may seem easy, but we want you to impress us with good GitHub etiquette and quality Markdown. The bare minimum would be to just passively follow the steps; you should do further reading about the tools languages we use so you can further your understanding and relieve confusion if you're unclear about how something works. Treat these steps as learning opportunities! The GitHub and Markdown skills you practice here are very important for both this program and a future software development career.

Pre-Requisites

Required Prerequisites

The following are the required hardware components that will be required to be part of the team. You will need some of the basic hardware of your own to make sure you can run, test and contribute to the software that the team is developing.

Hardware requirements:

  1. Laptop/Desktop with minimum 8GB of RAM
  • You will need a Wi-Fi adapter if you are using a desktop without Wi-Fi capabilities.
  1. Mobile device (phone or tablet)
  • Memory (RAM): Minimum 2GB

Step 0 - Introductory Steps

  1. Complete the Application form. If you have already done this after being invited to join the team then good job, you're all set!

  2. Log into your GitHub account then watch planetfarms.github.io repo and Follow Dogi.

Setting up your environment

We interact with a command terminal which is natively available for both Mac and Linux based systems. If however you are on a Windows device, Git Bash is highly recommended.

Working with Vi & Vim

One of the most simple but most powerful text editors out there is Vim. If you want to see what Vim can do and how powerful it can be, you can learn more about Vim here.

Step 1 - Github

  1. Log into your GitHub account then watch planetfarms.github.io repo and Follow Dogi and Lmmrssa on GitHub.

In GitHub, we "Watch" organization repositories and ["Follow" (https://help.github.com/en/articles/following-people) individuals. Look for the "Watch" button at the top right of the page when you are in a repository. Also, follow each other to see what others in the group are doing.

  1. Using GitHub

Step 2 - GitHub and Markdown

Follow the instructions on GitHub and Markdown

Make sure that you've linked to your github.io and pull request in the chat.

NOTE: The raw.githack link is case sensitive to your username.

Once you complete Step 2 you will have:

  • 1 Pull request made

Check your progress here

Step 3 - Software Tutorial

Package Managers

Package managers are systems that allows you to download other users software, known as packages, to help with you tasks. There are many variaties of package managers, but the ones we will be using the most is your operating system's package manager and node.js's npm. For more information check out the Package Manager Tutorial

NodeJS

Node.js is an open-source, cross-platform runtime that allows Javascript to be executed outside of a web browser for backend development. Node.js comes with built-in modules that allows developers to build servers with rich features using asynchronous APIs. To install Node.js, follow the directions in the Node.js Tutorial

Docker

Docker is a computer program that performs operating-system-level virtualization also known as containerization. In this step, you will learn the basics of interacting with Docker and Docker Compose through the command-line interface and basic commands for maintaining your Planet installation. Follow the directions in the Docker Tutorial

Step 4 - Planetfarms

There are 3 sub-steps in this step:

  1. PlanetFarms PlanetFarms is a system built in PERN Stack. This stack consists of PostgreSQL, Express, React and Node.js .

Step 5 - Keeping Fork Updated

Follow the directions at Git Repositories to keep your username.github.io and your local repository up to date.

Step 6 - Create Issues

Improve the PlanetFarms documentation and create at least 2 issues and pull request.

Once you complete Step 5 you will have:

  • 2 new pull request made

Check your progress here

Step 7 - Using Earthowned

  1. This step includes the Earthowned Manual, which explains different features and usage of Planet system.

  2. You should search for Courses and Library under Planetfarms and take those Courses and Library.

  3. Create at least 4 issues and pull request to improve Planetfarms manual.

Once you complete Step 7 you will have:

  • 4 new pull request made

Check your progress here

Step 9 - Join the team

Next thing is to post a screenshot of your completed progress to the chat. Click here to find your completed progress. Creat a Pull Request to add yourself team.md. Then message us ("@lmmrssa" and "@dogi") at chat and ask about setting up a meeting so you can become a part of the team as soon as possible.