Fundamentals, Methods and Project Management

This week was all about deepening the understanding of digital fabrication while refining project management and website development skills. The focus was on identifying the right tools and techniques for specific functions, structuring workflows efficiently, and enhancing personal digital presence.

A. Downloading Softwares & Setting Up

Initially, I was new to 80% of the softwares which were supposed to used for our journey. We were very lucky that our proffessor guided us. And to be honest, it was a bit confusing for first few hours. Exploring softwares really help, it was like following a map to explore places...but exciting once I got the hang of it.

Storage Matters!

One crucial lesson: storage is everything! Whether it's downloading, using, or setting up software, having enough storage makes a huge difference. A well-organized file structure helps keep things running smoothly.

Setting Up Essential Software**

To streamline installations, I used Ninitefantastic tool that installs multiple apps simultaneously without clicking 'Next' a hundred times. It's a huge time-saver, especially when setting up commonly used software.

Link to download: https://ninite.com/

I’ve downloaded some essential tools to keep our workflow smooth and efficient:

• WinMerge – A lifesaver when you need to compare files or folders without going cross-eyed. Helps you merge changes like a pro!

• CCleaner – Keeps your PC fresh by kicking out junk files, clearing browser gunk, and making things run smoother.

• Visual Studio Code (VS Code) – The go-to code editor for devs! Light, powerful, and packed with cool extensions to supercharge your workflow.

• ShareX – Screenshot and screen recording wizard! Snap, edit, and share with a click—perfect for capturing anything on your screen.

• WinDirStat – Turns your disk space into a colorful map, making it super easy to find and delete storage hogs.

B. Generate SSH Key

What is an SSH key?

An SSH key is a secure way to connect your computer to websites like GitHub or GitLab without using a password every time.

Public key 🏠 → Stored on GitHub/GitLab. Private key 🔑 → Stays safe on your computer.

It helps you push (upload) and pull (download) code securely and easily, without typing your password again and again! 🚀

1.Setting up an SSH key allows secure authentication with GitLab without entering credentials every time. To generate an SSH key:

step 1: Open Git Bash, Command Prompt, or PowerShell.

step 2: Run the following command:

ssh-keygen -C "your.email@example.com"

"your.email@example.com" adds an identifier (your email) to the key.

step 3: Press Enter to save the key in the default location.

If prompted, enter a passphrase for added security (optional but recommended).

step 4: Copy the public key to your clipboard.

step 5: Select and copy the entire output.

2.Add SSH Key to GitLab

step 1: Log in to GitLab and go to your account settings.

step 2: Navigate to Preferences → SSH Keys.

step 3: Paste the copied SSH public key into the provided field.

step 4: Click Add Key.

step 5: To confirm the key is working, run:

ssh -T git@gitlab.com

step 6: If successful, you should see a message like:

Welcome to GitLab, @your-username!

3.Play Around with GitLab’s WebIDE

step 1: Navigate to your GitLab repository.

step 2: Click on WebIDE (an online editor inside GitLab).

step 3: Open a file, make a small change, and commit it directly through the WebIDE.

step 4: Observe how GitLab tracks changes, branches, and commits without needing a local setup.

4.Clone Your Repository to Local Machine

step 1: Copy the SSH clone URL from your GitLab repository (e.g., git@gitlab.com:your-username/your-repo.git).

step 2: Open a terminal and run:

git clone git@gitlab.com:your-username/your-repo.git

step 3: Navigate into the newly created project directory:

cd your-repo

step 4: Verify the remote is set up correctly:

git remote -v

This should display the origin linked to your GitLab repository.

C. Mk Docs: Documentation Made Easy

MkDocs is our go-to static site generator for turning Markdown files into clean, organised website. With just a few config tweaks it compiles project information which is convinient for sharing instructions.

1.Setting Up MkDocs

Install Python (from python.org). Ensure you check the "Add to PATH" option during installation. (Essential to run MkDocs!)

Install MkDocs using:

'pip install mkdocs' (Downloads and sets up MkDocs on your system!)

Create a new project:

mkdocs new my-docs 'cd my-docs' (Creates a folder for your documentation!)

Run the live preview:

'mkdocs serve' (Opens your documentation in a browser for real-time edits!)

Edit mkdocs.yml to organize navigation and themes. (Customizes the look and structure!)

Deploy with:

'mkdocs gh-deploy' (Publishes your documentation online via GitHub Pages!)

D. Install VSCode and Extensions

step 1: Download VSCode from 'ninite.com.'

step 2: Install VSCode and launch it.

step 3: Open the Extensions Marketplace and install:

Python (if working with Python projects)

Markdown All in One (for better Markdown handling, useful for MkDocs)

Remote - SSH (to work on remote projects if necessary)

E. GIT: Version Control & Collaboration

Git is a bridge to save and manage different versions of our projects.

1.Installing Git

Use Ninite to install Git hassle-free. (Quick install without manual setup!) or directly download from Google.

The 64-bit version of Git is better for Windows because it handles large repositories more efficiently, utilizing more RAM to prevent crashes and memory issues.

Check if Git is installed:

'git --version' (Confirms installation!)

2.Setting Up Git & SSH Key

Configure Git with your credentials:

git config --global user.name "Your Name" git config --global user.email "your@email.com" (Links Git to your identity!)

If you have a key to copy, you ca open in notepad and save it.

Generate an SSH key (to avoid password prompts):

ssh-keygen -"your@email.com" (Creates a secure connection to GitHub!)

Clone a repository to start working:

git clone (Downloads the project to your system!)

3.Git Workflow Basics

Pull updates before making changes:

git pull origin main (Fetches the latest changes from GitHub!)

(trial)

Stage & commit changes:

git add . git commit -m "Updated project files" (Saves your progress locally!)

Push to GitHub:

git push origin main (Uploads your changes to GitHub!)

What is Cloning? In Git, cloning is the process of creating a copy of a remote repository (like one on GitHub or GitLab) on your local machine. This allows you to work on the project, make changes, and commit them without affecting the original repository until you're ready to share your work.

Is it Important? In my experience, cloning a repository is super helpful. It gives me a full, local copy of all the project files and their entire history, including previous commits. This lets me easily make changes, keep track of my progress, and later push updates back to the remote repo. It’s definitely a smooth process that makes collaborating with others a lot more efficient.

Important things I learnt while PREPARING :

-Tracking changes is easier

-Committing and Saving changes is neccessary

-Push and Pull regularly

-Fixing conflicts in moment helps in long term

-Keeping files organised makes process easier

-Branches make work easier

F. Organising Folders

Keeping files structured saves time. (Helps find what you need instantly!) MAKES DOCUMENTATION REFINED.

📂 CAD_Project

📁 2D_Designs/ (Sketches, Vector Files)

📁 3D_Models/ (Fusion 360, FreeCAD Files)

📁 Renders/ (Screenshots, Final Renders)

📁 Documentation/ (MkDocs, Images, Notes)

Using meaningful names and version numbers like 'design_v1.f3d, final_render_01.png' made tracking progress easier. (No more lost files!).

G. Python & Pip Configuration

Python is essential for automation and running MkDocs. Setting it up correctly avoids errors later. (Makes coding and documentation seamless!)

1.Installing Python

Download Python from python.org. (Base requirement for MkDocs!)

Check “Add Python to PATH” during installation!

Verify installation:

python --version (Confirms that Python is installed!)

2.Installing & Configuring Pip

Check if Pip is installed:

pip --version (Ensures you can install packages!)

Fix issues (if any):

python -m ensurepip --default-pip (Restores Pip if missing!)

Install required libraries:

pip install numpy matplotlib (Installs essential Python tools!)

H. Fixing PATH Issues (If Needed)

If the python command didn’t work, I had to manually add Python to my system’s environment variables. Here’s how I did it:

1.Open Control Panel > System > Advanced System Settings

2.Click Environment Variables

3.Under System Variables, find and select Path, then click Edit

4.Click New and add the path to Python’s installation folder (e.g., C:\Users\MyUser\AppData\Local\Programs\Python\Python312)

5.Also, add the Scripts folder: makefile

C:\Users\MyUser\AppData\Local\Programs\Python\Python312\Scripts\ Click OK to save changes, then restart the terminal

After this, running python --version worked perfectly

I. Valuable Discoveries

• Understanding Digital Fabrication – Exploring different methods and how they fit various design needs.

• Learning from Past Projects – Analyzing previous work to refine my design approach.

• Improving Workflow & Organization – Managing files efficiently, optimizing processes, and using the right tools.

• Building a Personal Website – Structuring content, setting up the backend, and ensuring seamless functionality.

These lessons not only helped me make better use of technology but also strengthened my organization and presentation skills, making my work more structured and effective.

Some key lessons learned along the way

1.Never skip the “Add to PATH” option during installation (or future me will be crying).

2.Verifying everything with --version commands is your best friend to catch issues early.

3.Testing installations with simple commands, like pip install requests or git --version, makes sure nothing’s left behind.

4.And for the love of sanity, use virtual environments to keep projects clean and organized!

5.Now, with everything finally set up, I’m ready to actually get my hands dirty with some code, commit changes, and create that sweet MkDocs documentation without any more hiccups.

It’s been a journey, but I’ve come out the other side—ready for what’s next.