WEEK1 Project Management / Principles and Practices
WEEK1 Project Management / Principles and Practices
Plan and sketch a potential final project
Food DehyDrator
The main purpose of making this food dehydrator is to dry vegetables. Drying vegetables removes moisture, allowing them to keep longer without spoiling. It is very economical and eco-friendly, reducing waste. Commercially sold dried vegetables seem to rarely be sun-dried. The food dehydrator I will develop will sun dry the vegetables on sunny days and use a heater to dry them on rainy days. Incorporating sun-drying (exposing them to ultraviolet rays) can increase nutritional value and create new nutrients. We can expect both the quick drying from heater drying and increased nutrients from incorporating sun-drying.
*Claude, an AI from Anthropic, helped generate this text.
Project Management
Student Agreement
Fab Academy Student Agreement
The Fab Academy is responsible for:
- Teaching principles and practices of digital fabrication
- Arranging lectures, recitations, meetings, and events for the class
- Evaluating and providing feedback on student work
- Offering clear standards for completing assignments
- Certifying and archiving student progress
- Supervising class preparation
- Reviewing prospective students, instructors, and labs
- Providing central staff and infrastructure for students, instructors, and labs
- Fund-raising for costs not covered by student tuition
- Managing and reporting on the program's finances, results, and impacts
- Publicizing the program
- Promoting a respectful environment free of harassment and discrimination
- Encourage a diverse, accessible, and equitable community
I am a Fab Academy student, responsible for:
- Attending class lectures and participating in reviews
- Developing and documenting projects assigned to introduce and demonstrate skills
- Allowing the Fab Academy to share my work (with attribution) in the class for purposes compatible with its mission
- Honestly reporting on my work, and appropriately attributing the work of others (both human and machine)
- Working safely
- Leaving workspaces in the same (or better) condition than I found them
- Participating in the upkeep of my lab
- Ensuring that my tuition for local and central class costs is covered
- Following locally applicable health and safety guidance
- Promoting a respectful environment free of harassment and discrimination
Signed by committing this file in my repository,
Hajime Ito
Git
Git Setup
Install and Setup Git
Download git installer from the site below. URL: https://git-scm.com/download/win
git config --global user.name "myname" git config --global user.email "my@email.com"
PS C:\Users\budob\repos\hajime-ito> git config --global user.name hito PS C:\Users\budob\repos\hajime-ito> git config --global user.email my@gmail.com
Generate SSH key
cd ~ mkdir ~/.ssh cd .ssh ssh-keygen -t ed25519 cat id_ed25519.pub | clip
Add Public key in gitlab
Paste clipped SSH key to "Key"
Build a personal site
I decided to build my site with Markdown.
Repository
Remote Repository (gitlab, fabcloud)
https://gitlab.fabcloud.org/academany/fabacademy/2024/labs/kannai
Local Repository
mkdir repos
cd repos
git clone git@gitlab.fabcloud.org:academany/fabacademy/2024/labs/kannai/students/hajime-ito.git
Visual Studio Code Instllation(VS Code)
Download: https://code.visualstudio.com/
Markdown Installation
Installing Python from "https://www.python.org/"
PS C:\Users\budob\repos> python --version
Python 3.12.1
PS C:\Users\budob\repos> pip --version
pip 23.2.1 from C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.12_3.12.496.0_x64__qbz5n2kfra8p0\Lib\site-packages\pip (python 3.12)
pip install mkdocs
pip list
Package Version
--------------- -------
mkdocs 1.2.4
PS C:\Users\budob\repos> mkdocs --version
mkdocs, version 1.2.4 from C:\Users\budob\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\site-packages\mkdocs (Python 3.12)
PS C:\Users\budob\repos> where.exe mkdocs
C:\Users\budob\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\Scripts\mkdocs.exe
PS C:\Users\budob\repos> pip show mkdocs
Name: mkdocs
Version: 1.2.4
Summary: Project documentation with Markdown.
Home-page: https://www.mkdocs.org
Author: Tom Christie
Author-email: tom@tomchristie.com
License: BSD
Location: C:\Users\budob\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\site-packages
Requires: click, ghp-import, importlib-metadata, Jinja2, Markdown, mergedeep, packaging, PyYAML, pyyaml-env-tag, watchdog
Required-by: lantana, mkdocs-awesome-pages-plugin, mkdocs-git-authors-plugin, mkdocs-git-revision-date-localized-plugin, mkdocs-git-revision-date-plugin, mkdocs-macros-plugin, mkdocs-material, mkdocs-mermaid2-plugin
PS C:\Users\budob\repos\hajime-ito> mkdocs serve
INFO - Building documentation...
Markdown Theme
I chose Lantana(https://github.com/WSOFT-Project/lantana) for my MkDocs Themes.
PS C:\Users\budob\repos\hajime-ito>pip install lantana
PS C:\Users\budob\repos\hajime-ito>mkdocs new hajime-ito
==Copy the following template into "mkdocs.yml".==
site_name: My Fab Academy 2024 Website
docs_dir : 'docs'
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
language : ja
theme: lantana
visible_search : true
plugins:
- search:
lang : 'ja'
min_search_length: 2
- macros
- awesome-pages
- git-authors
markdown_extensions:
- attr_list
- pymdownx.highlight:
anchor_linenums: true
- admonition
- pymdownx.arithmatex:
generic : true
- md_in_html
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.magiclink
- pymdownx.striphtml
PS C:\Users\budob\repos\hajime-ito> mkdocs build
PS C:\Users\budob\repos\hajime-ito> mkdocs serve
INFO - Building documentation...
Remote Repository
PS C:\Users\budob\repos\hajime-ito> git add .
PS C:\Users\budob\repos\hajime-ito> git status
PS C:\Users\budob\repos\hajime-ito> git commit -m "Feb1"
PS C:\Users\budob\repos\hajime-ito> git push
Enumerating objects: 61, done.
Counting objects: 100% (61/61), done.
Delta compression using up to 12 threads
Compressing objects: 100% (57/57), done.
Writing objects: 100% (59/59), 2.41 MiB | 1.50 MiB/s, done.
Total 59 (delta 6), reused 0 (delta 0), pack-reused 0
To gitlab.fabcloud.org:academany/fabacademy/2024/labs/kannai/students/hajime-ito.git
79b4f65..f555deb main -> main
The commands git add ., git commit -m "comment1", and git push are commonly used steps to send local changes to a remote repository in Git.
First, you use git add to stage the files you've modified, then git commit to save those changes to your local repository, and finally git push to upload those committed changes to the remote repository.
These commands are essential for collaborating on projects with multiple people, as they allow you to share and merge changes from different contributors. They also help maintain a history of all the changes made to the codebase over time.