Week 1. Principles and practices

Assignments of the week

• Plan and sketch atleast two final projects idea
• Download git and document steps for creating your own repository
• Create your own personal website

Final Project Ideas

Final project No.1

1. Waste segregation and detection

This is my first proposed idea of final project that is to make the lid of dustbin to open and close automatically. The main idea of this project came into my mind after seeing that most of the people are so reluctant to open the dustbin when they are dumping waste, they just throw it where ever they like so inorder to avoid that and minimise waste dispersal in office premises or houses I decided to do this project.

In this project I am planning to attach one ultrasonic sensor on the dust bin near to it’s lid so when ever we show something infront of the sensor or when the dustbin detects the motion the lid opens and closes back.

Final project No.2

1. Smart plant watering system

This is my second proposed idea of final project. The name of the project is smart plant watering system. The main aim of of the project is to water the plant automatically when ever the soil becomes dry and it requires water.

The main inspiration of this project came into my mind as sometimes it becomes difficulf for us to water the plant daily due to our own work, so during that time it will be benefecial for us as we need not have to water the plant manually as it will be done automatically.

I am planning to put moisture sensor inside the flower pot so whenever it sense that the soil is dry the pump runs and water the plant and pump stops back after sensing the mositure in the soil and the cycle continues.

What is Git?

As per my understanding and after going through the website, Git is a kind of platform which is user friendly and works through internet services where any one can use it to create our own repository before starting new projects and documenting it. Not only that it also allows the user to clone the project locally in our disk so that the user can work offline too and push up the finalised documents to the online repository when ever required.

After that I downloaded and installed the Git from the google

The image above shown are process of downloading and installing git in my computer

After that I ran the installer and and to verify git version I typed git –version after opening git bash

Git commands

After downloading and installing git, I learned some of the basic commands in git that we required and will be using every time we use git. Below mentioned are some of them which are as follows;

• Git clone: this is the first step that we carry out inorder to download copy of our project from online git into our local disk. For that we just need to copy either SSH or HTTPS link and paste it into our local disk as per our convenient.

• Git status: this is the second step after creating the copy of project in local disk, which helps us in highlighting what all new changes are being made.

• Git add . : this is the third step and it is also one of the most important step because if we forget to add dot(.) after typing (git add) than what ever changes we had made won’t be uploaded in the online repository so basically dot here means to add whole documents and to add individual document we can just type the name of the file.

• Git commit -m”“: this is the fourth step and this step is done to confirm the final message before pushing it into the online repository.

• Git push: this is the fifth step and it helps us to upload all the changes in online repository.

Creating SSH key

In order to generate SSH key I typed;

git config –global user.name”roshan-rai”

git config –global user.name”roshanrai@dhi.bt”

Those above two steps are carried out in order to identify our email and Git user name.

After that for generating the SSH key I just typed;

cat~/.ssh/id_rsa.pub

At the first attempt I was not able to generate key since I forgot to add space between cat and (~) symbol. So next step I just typed;

cat ~/.ssh/id_rsa.pub with space in between cat and (~) which helped me to generate my SSH key.

Next I copied the whole key and opened my fab academy home page, and clicked on preference option which I got after hovering on the small icon next to home page icon

After clicking on the preference, we will be taken to the next page where we can see SSH keys option. So in order to add key I just clicked on the “Add new key” which is present on the right hand side of the page.

Followed by that I pasted the SSH key in the space where I am required to add the key.

Finally after I am happy with my SSH key, I just clicked on “Add key” and my new SSH key is created and added in git.

Steps to clone the repository in local disk

Firstly I had copied the SSH key url link from my home page.

Next I opened the git bash and run the command as;

After the cloning of SSH url link is sucessful, my repository has been created in the local disk.

Create your own personal website

To create the website we were given HTML template but I chose markdown over HTML since I am quite comfortable using markdown and I had also decided to use markdown for documentation of assignments and final project.

So in order to create my own personal website I had downloaded the fab template from Julian’s Student Template Mkdocs After downloading the template, I deleted all HTML and .yml files which are created by fab academy coordination and replaced them with Julian’s template.

What is mark down

With help of google I came to know that markdown was created by John Gruber in 2004 and It says that it is a light weight mark up language for creating formatted text using a plain text editor and not ony that it is also one of the world’s most popular mark up languages.

Here are some basic examples of Markdown syntax:

# This is a Heading 1
## This is a Heading 2
### This is a Heading 3 
- Unordered Item 1 
- Unordered Item 2 
1. Ordered Item 1 
2. Ordered Item 2 
[Link Text](http://example.com)
*italic* or _italic_
**bold** or __bold__
![alt text](image.jpg)

In addition to that, I had also gone through some of the links mentioned below to understand more regarding the markdown syntax

• Markdown cheatsheet

• Git hub formatting and writing syntax for markdown

Installing VS code

Install VS code

VS code can be downloaded freely from the web and while downloading we need to choose as per our computer’s operating system. As I am using windows I have chosen windows to download it.

Next I Installed “markdown all in one” from the drop down menu after installing the VS code.

Then I Opened the student template folder in VS code and started editting mkdocs.yml file. There I had given user name and link of my new template after replacing with Julian’s template.

This image shows how I have changed the user name and site URL before starting documenting

After that I started writing in my Home page by giving short discription, which I had editted in index.md docs file.

Followed by that, I started writing the About me page in index.md file which describes me in quite detail and my motive of joining fab academy this year.

Finally after I am done with everything, I pushed the documents in the git and my website was created.

The steps below shows how I pushed my document in online repository.

Firstly I typed git status to check whether there has been changes made or not in the files which I had edited.

Secondly I typed git add . to add all files at once.

Thirdly I typed git commit -m”“ to add small description about the files which we had changed or edited.

Lastly I typed git push in order to update all the changes that I had made locally in online repository.

Steps to push documents using gitlens

1. Open the project folder in Visual Studio Code.

2. Open and make changes to the specific file that you want to edit.

3. After we modify files, gitlens will notify pending changes in the source control system.

4. Click on the “+” icon to prepare your changes before committing.

5. Enter the message that you have changed, then click on the commit button.

6. Finally to push up your document in cloud you just need to click on “Sync” option and once you are done it will be updated in online repository.

Thank you have a nice day.