1. Principles and practices, Project management

PRINCIPLES AND PRACTICES

Activities Completed

• FabAcademy Day 1 Video: Watched and studied the content from the first day’s session
• Project Ideation: Developed concepts for 5 potential final projects

The 5 potential final projects under consideration are:

• Medical Pill Dispenser: An automated system for accurate medication dispensing and tracking .

• Hologram Display: A device capable of creating holographic visual displays

• Smart Desk Organizer: An intelligent solution for workspace organization and management

• Packing Machine: An automated system for efficient product packaging and sorting

• Automated Quantity Inspection System: A system using sensors and imaging for product quantity check and report the number of items .

This is my final project ,and my concept as of now is to help me in my factory .

PROMPT AND AI TOOL USED

I used deep ai to generate these images . i just inputed above  details and asked deep ai to generate and regenerated till the moment when i was happy with the generated the images . 

sample prompt " Generate an image of Smart Desk Organizer which is An intelligent solution for workspace organization and management . 

Click here to access Deep Ai

Project Development Progress

Created a foundation for project selection by exploring multiple concepts and their visual representations. This approach will help in making an informed decision for the final project selection.

Next Steps

• [ ] Evaluate and analyze each project concept in detail
• [ ] Compare the feasibility of each project
• [ ] Select the most viable project for final implementation

FINAL PROJECT

I have selected the Product number counting system as my final project. where it counts the number products that are coming through the conveyor belt . I have attached a initial drawing below .

As i do have a factory of manufacturing injection molded components . I thought it would be useful for me to test it out , so i could implement it from my side or i could understand the processes behind it so that i could negotiate and tell the requirements with different vendors .

My next steps are to install Git Bash, generate an SSH key, and clone the repository.

Project Management

To clone and add repository we are using git bash for the process . so i downloaded it and the further steps are listed below .We are using Gitlab as our version control to document the process since fabacademy repositories are hosted on gitlabs . it would help as to make our documentation smoother .Gitlab would allow save our documenation on the go , if lost , some errors happens too we could pull the last correct item . this is what i understood about git lab.

Version Control

Version control, also known as versioning or source control, tracks and manages changes to source code. It maintains a detailed record of every modification, making changes both trackable and reversible.

Version control is essential for software development and project management, with code tracking and versioning at its core.

Getting started with GIT

There are different version controls like gitlab, github , beanstack etc . Here we are using gitlab for our activities . Git is the free, open-source distributed version control system that manages all GitLab-related activities on your local computer.

Learn Git Branching

I have learned some basic functions using the below website .

Learn Git Branching🔗https://learngitbranching.js.org/

Git Installation

So i downloaded git . You could download git using the link below .

Download here

Git Configuration

git config --global user.name "Your Name"

git config --global user.email "your_email@example.com"

• git config: Command to set Git configuration options.
• -global: Applies the settings globally for all Git repositories on your system.
• user.name: Sets your name for commit identification.
• user.email: Sets your email for commit identification.

PROMPT

how to generate ssh key in git bash . what is it used for

Setting up SSH keys

Open Git Bash

Enter the following command with your GitHub email address:

ssh-keygen -t rsa -b 4096 -C "[your_email@example.com]"

Steps to Generate an SSH Key in Git Bash

1. Open Git Bash: Launch Git Bash on your system.

2. Run the SSH Key Generation Command:

   Use the following command to generate an SSH key pair (private and public keys):Replace "your_email@example.com" with your email address. If your system doesn’t support ed25519, use:

   ssh-keygen -t ed25519 -C "your_email@example.com"

   In my case ed25519 was not working so i used the below code to generate the ssh key.

   ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

   I was confused about the differences between these methods, so I consulted Perplexity AI for clarification.

   

   What i understood is that Rsa and ed25519 are two different algorithsm RSA and Ed25519 are two types of SSH key algorithms that are used , and ed25519 is the more stronger one to peneterate and it occupies less space than rsa .

3. Save the Key Pair:

   • When prompted to “Enter a file in which to save the key,” press Enter to accept the default location (~/.ssh/id_ed25519 or ~/.ssh/id_rsa).
   • If you want a custom location, specify it.
4. Set a Passphrase (Optional):You can add an extra layer of security by entering a passphrase or leave it blank by pressing Enter.
5. Start the SSH Agent:Run the following command to start the SSH agent: `eval "$(ssh-agent -s)"`
6. Add the Private Key to the SSH Agent:Navigate to the directory where your private key is stored, then run:Replace id_ed25519 with your private key file name if you used a different algorithm or name. `ssh-add ~/.ssh/id_ed25519`

7. Add Your Public Key to GitLab:

   • Copy the contents of your public key file (id_ed25519.pub) using: `cat ~/.ssh/id_rsa.pub`

   • Log in to Gitlab and then go to preferences and then add public ssh key to it . the key that is generated now .

   

Purpose of SSH Keys

SSH (Secure Shell) keys are used for secure authentication between your local machine and remote servers like GitHub or GitLab. They serve two main purposes:

1. Authentication Without Passwords: Instead of entering your username and password every time you interact with a remote repository, SSH keys allow automatic authentication. This is both more secure and convenient27.
2. Enhanced Security: The private key remains on your machine, while the public key is shared with the server (e.g., GitHub). This ensures that only you can access and push changes to repositories associated with that public key27.

Steps to Clone the Repository

1. Copy the Repository URL:
   • Log in to your GitLab account.
   • Navigate to your FabAcademy repository.
   • Click the Clone button and copy the SSH URL (e.g., git@gitlab.com:username/repository-name.git).
2. Open Git Bash:
   • Launch Git Bash on your computer.
3. Open the Command Palette:
4. Run the Clone Command:
   • Type Git: Clone in the Command Palette

5. Paste the Repository URL:

   • Paste the SSH URL you copied from GitLab into the prompt and press Enter.

   

6. Select a Local Folder:

   • Choose a folder on your computer where you want to clone the repository, then click “Select Repository Location.”

Then i installed Vs code for further development as my instructor told to download it so you could do the further website building and documentation using that IDE

VS CODE

Visual Studio Code (VS Code) is a powerful, free source-code editor developed by Microsoft. It includes built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages and tools. Some key features that make VS Code particularly useful for development include:

• Integrated Git control and debugging support
• IntelliSense code completion

• Built-in terminal integration Install Visual Studio Code (Download VSCode)

• Open the Repository in VSCode:

  • After cloning, VSCode will prompt you to open the repository. Click “Open” to start working on your project.

  DOWNLOAD LIVESERVER EXTENSION AND ADD .

  

  This is how it looks like . This helps to host a local server so you could see live updates . It could be seen at the bottom right corner with an option called Go Live .click that so it is hosted locally . so you could see your changes on the go .

Website Development

After cloning the git and downloading the vs code my next task is to develop my site . I did some changes to my site using html . I used to know basic html and with the help of my instructors i was able to make some changes like adding my name , photo aligning it etc .

Above i have provide the changes that i made and what changes and where to make . and the results are below .

Next is the index page .

These are the basic things that i updated using html .

Add,Commit Push

i have made the change and now i have to push the documentation to the github repository . The command that i have used are listed below .

git add . Used to add the changes

git commit it helps to add a note to the added change or information .

git push It is used to push this to github servor .

Checking Repository Status

git status

• git status: Shows the current state of your working directory and staging area.

since the process was time consuming for me , iasked my instructor for an alternative method and my instructor told me about mkdocs . Then i thought to try it . With the help of my instructor i was able to install mkdocs .

Then i was not liking the colour so i looked how to change it . I got a website that tells how to edit in mkdocs . i will be attaching it below . mkdocs editing website

copy the code mentioned above and paste in the mkdocs.yml file as given below .

And i have finally setted up mkdocs and i am using it . And it is easy to use .

Conclusion

This week i have studied how to install git and clone repositories and did some basiic html and also installed mkdocs which would help me in the future documentation .we also came up with different project ideas for final project and we have chosen one from the five .

---

Last update: March 2, 2025