📚 #PythonJourney | Day 146 — Documentation & Repository Setup After fixing the code and getting Docker running (Days 144-145), today was about making the project shine on GitHub. Key accomplishments: ✅ Fixed Git repository structure: • Moved .git from app/ to project root • Created comprehensive .gitignore • Cleaned up untracked files ✅ Created detailed README.md: • Project overview & features • Complete tech stack documentation • Local development setup guide • API endpoints reference • Docker commands • Development status & roadmap ✅ Added GitHub repository metadata: • Meaningful "About" description • Keywords and documentation • Clear project visibility ✅ Pushed all changes to GitHub What I learned: → Repository structure matters for large projects → Good README is as important as good code → Clear documentation attracts contributors & employers → Git workflow: understand your project root location The project now has: - Clean code structure - Detailed documentation - Professional GitHub presence - Clear roadmap for next steps Next: Create SQLAlchemy models and start writing tests. #Python #FastAPI #GitHub #Documentation #Backend #OpenSource #SoftwareDevelopment #DevOps
Marcos Vinicius Thibes Kemer’s Post
More Relevant Posts
-
AI developers spend a lot of time prompting. But shipping anything beyond a script means working with code — branching, versioning, collaborating with others. And in that area, Git and GitHub are non-negotiable: incredibly powerful, but their core concepts are often skipped over. I felt I was missing those fundamentals while building my own projects. So I built a Git & GitHub course from scratch — using Claude Code itself as the instructor. It's hands-on. 11 progressive lessons, each with theory and a real practice session on a real repo. You don't type git or gh commands — you tell Claude what you want to do in plain English, Claude runs the real commands, and walks you through every state change step by step. You'll build the mental model of where your code actually lives at any moment. And that's what actually matters. Sharing it because I think it can save someone else the same gap. Download the repo and open it in Claude Code, say "start lesson 1", and Claude will guide you. Progress is tracked inside the repo itself, so you can pick up right where you left off. Link below. #git #github #claudecode #aidevelopment #devtools
To view or add a comment, sign in
-
-
Ever wondered what actually happens under the hood when you type git commit or git merge? I decided to move beyond just using developer tools and actually understand the system architecture behind them. So, I’ve been developing CAF, a custom Version Control System written in Python and C++ to replicate the core mechanics of Git. Building a VCS is a masterclass in file systems, graph theory, and data structures. It's more than just a file-copier, it’s about managing state and history: 🔹 Object Database: Cryptographically hashed blobs and trees (DAG) for content-addressable storage. 🔹 Branch Namespacing: Native directory-based branch resolution to manage complex workflows. 🔹 3-Way Merge Engine: A custom algorithm capable of finding common ancestors, detecting textual conflicts, and writing Git-style conflict markers for developer resolution. 🔹 Full CLI Suite: Includes robust implementations for checkout, log, status, and tag, providing a familiar, Git-like developer experience. 🔹 DevEx First: Packaged the entire engine inside a Dockerized GitHub Codespaces environment for zero-setup testing. If you want to see the engine in action (or try breaking the merge algorithm right in your browser), you can spin up a live environment from my repository here: 👉 https://lnkd.in/dMiDs6fp #SoftwareEngineering #Python #SystemArchitecture #Git #OpenToWork #Backend
To view or add a comment, sign in
-
My workflow: From GitHub Projects to PR. It all starts with a GitHub Project issue. If the requirements don't align with the business logic or lack clarity, I don't start. I ask, find solutions, and align expectations first. Once the path is clear, I move to planning: Impact Analysis: How does this affect the current stack and future features? Do we need new models? Do we need changes in other modules? Implementation Roadmap: A technical step-by-step before touching the IDE. Then comes the execution. I’m not about delegating everything to AI—I like to get my hands dirty and stay on top of the code. I use AI to speed things up, but it always follows my architecture and my technical criteria. Coding is just the final step of a solution that’s already been engineered. #SoftwareEngineering #WebDev #GitHub #Programming #CleanCode #FullStack
To view or add a comment, sign in
-
POST 3 of 10 — Core Concepts (The Mental Model) This mental model is what finally made Git click for me. Most people jump straight into commands without understanding what’s actually happening. Don’t be that person. Git has 4 zones — and files move through them in order: Working Directory → Staging Area → Local Repository → GitHub (your files) → (git add) → (git commit) → (git push) Think of Git like mailing a package 📦 📁 Working Directory — items on your desk 🎯 Staging Area — items placed in the box (git add) 💾 Commit — the sealed box with a label (your message) ☁️ Push — shipping the box to GitHub’s warehouse POST 4 of 10 — Essential Commands You don’t need to memorize 100 Git commands. You need these 15. That’s it. 📊 See what’s happening: git status # run this constantly git log --oneline # compact commit history git diff # line-by-line changes 💾 Save your work: git add . # stage everything git add file.py # stage one file git commit -m "msg" # save a snapshot ☁️ Sync with GitHub: git push # upload commits git pull # get latest changes git clone <url> # copy a repo 🌿 Work with branches: git checkout -b feature-name # create + switch git checkout main # go back to main git merge feature-name # merge changes git branch -d feature-name # delete merged branch 🆘 Oops, undo: git restore file.py # discard file changes git revert HEAD # undo last commit safely The most important command? git status Run it before and after every Git command until it’s muscle memory. #Git #GitHub #CodingTips #Programming #DataScience
To view or add a comment, sign in
-
Accidentally pushed code to my work GitHub instead of personal. Couldn't find a clear fix anywhere — so I built one. I made a complete open-source guide for managing multiple GitHub accounts on one machine: 1. SSH key setup for each account 2. ~/.ssh/config with host aliases 3. Interactive guide with Personal / Work toggle 4. Copy-ready commands for every step 100% free. No fluff. Link: https://lnkd.in/d6jcZMnb Star it if it helps ⭐ #github #git #developer #devtools #opensource #coding #programming
To view or add a comment, sign in
-
🚀 𝟳 𝗚𝗶𝘁 𝗖𝗼𝗺𝗺𝗮𝗻𝗱𝘀 𝗘𝘃𝗲𝗿𝘆 𝗗𝗲𝘃𝗲𝗹𝗼𝗽𝗲𝗿 𝗦𝗵𝗼𝘂𝗹𝗱 𝗞𝗻𝗼𝘄 If you're a developer and not comfortable with Git… you're making your life harder than it needs to be 👇 1️⃣ git clone → Copy a repository to your local machine 2️⃣ git status → Check what’s changed 3️⃣ git add . → Stage all changes 4️⃣ git commit -m "message" → Save your changes 5️⃣ git push → Upload code to GitHub 6️⃣ git pull → Get latest updates from repo 7️⃣ git checkout -b branch-name → Create & switch to a new branch 💡 Bonus Tip: Use branches. Don’t push everything to main 😅 🧠 Reality: Good developers don’t just write code… they manage code properly. 💾 Save this for later 🔁 Share with your dev friends 👨💻 Follow for more dev tips #Git #GitHub #Developers #Programming #WebDevelopment #CodingTips #SoftwareEngineering #TechSkills #100DaysOfCode
To view or add a comment, sign in
-
-
🚀 Day 93 of #1000DaysOfCoding Today was less about coding… and more about becoming a real developer. I finally moved my full-stack project from local to GitHub — sounds simple, but the journey was full of real-world challenges: 💥 Faced Git errors like large file limits 💥 Accidentally pushed node_modules (never again 😅) 💥 Learned why .gitignore is not optional 💥 Understood how Git actually tracks history (not just files) 💥 Fixed branch & remote issues like a pro And the best part? ✅ Clean repo structure ✅ Proper version control setup ✅ Ready for deployment 🚀 This wasn’t just “uploading code” — It was understanding how developers actually work in production. 💡 Small lesson: If your code works locally but you can’t version or deploy it — you’re not done yet. Next step: 👉 Deploying this project live (Frontend + Backend + DB) Let’s see how it goes 🔥 #1000DaysOfCoding #Day93 #Git #GitHub #FullStackDevelopment #SpringBoot #ReactJS #MongoDB #LearningInPublic #DeveloperJourney
To view or add a comment, sign in
-
🚀 From Writing Code → To Automating Everything! Recently, I worked on my project WealthLens and took a big step forward — I implemented my first CI/CD pipeline using GitLab. At first, I didn’t even understand why CI/CD is important… but while building it, everything started making sense. Here’s what I learned 👇 🔹 Every push is automatically verified No more “it works on my machine” — GitLab builds, runs, and tests everything automatically. 🔹 Real errors taught me real lessons Faced issues like: Maven not found Wrong environment setup Missing configurations And fixed them step by step. 🔹 Team collaboration became clear Worked with branches, commits, and Merge Requests — just like real companies. 🔹 Confidence boost 🚀 Now I know how real-world development works: Write → Push → Validate → Merge 💡 Biggest takeaway: CI/CD is not just automation… it’s a safety system for your code. 🔗 Project Link: https://lnkd.in/d6HgAD2C Tech Stack: Java | Spring Boot | Python (Flask) | GitLab CI/CD | Git Next step: Deployment 🌐 #CICD #GitLab #JavaDeveloper #SpringBoot #LearningByDoing #FullStackJourney
To view or add a comment, sign in
-
-
🚀 Every developer remembers the moment Git finally “clicked” 😅💻 At first, it’s confusing… branches, commits, merge conflicts 🤯 But once you get it — you can’t code without it. I’ve put together a clean visual cheat sheet: ✔️ git init & clone ✔️ add, commit & status ✔️ branching & switching ✔️ merge vs rebase ✔️ push & pull ✔️ stash, diff & reset 💡 These aren’t just commands — they’re how real-world development actually works. Whether you're a beginner struggling with Git or someone who still Googles commands (we all do 👀), this will help you move faster ⚡ 👉 Save this post for later 👉 Share with your dev friends 👉 Comment the Git command you use the most 👇 #Git #GitHub #Programming #Developers #Coding #SoftwareDevelopment #LearnToCode #Tech #100DaysOfCode #WebDevelopment
To view or add a comment, sign in
-
Most people use Git. Very few understand why it’s so efficient. Here’s the short explanation 👇 🧠 Git = content-based system It doesn’t store files. It stores snapshots (via hashes) Same content? → Stored once. No duplication.(deduplication) ⚙️ What happens in a commit? git commit -m "update" Behind the scenes: • Blob → file content • Tree → folder structure • Commit → snapshot + metadata Everything linked with hashes 🔗 📦 Why Git stays fast • Packfiles → bundle objects • Delta compression → store only changes Change 1 line? Git stores just that. Not the whole file. !! Without this the repose just explode !! 🔧 Hidden layer (most ignore) • Porcelain → git add, git push • Plumbing → actual engine Try this once 👇 echo "hello" | git hash-object -w --stdin You just created a Git object manually. If you understand internals → branching, rebasing, debugging becomes easy. 💡 Insight Git isn’t storing history… It’s storing connected snapshots 📚 Quick refs: https://lnkd.in/gSeM2kmA https://lnkd.in/gEMefujR Git becomes powerful the moment you stop memorizing… and start understanding ⚡ 👉 What part of Git still feels confusing to you? #Git #DevOps #Engineering #Backend — Abhishek Singh Chauhan
To view or add a comment, sign in
-
Explore related topics
Explore content categories
- Career
- Productivity
- Finance
- Soft Skills & Emotional Intelligence
- Project Management
- Education
- Technology
- Leadership
- Ecommerce
- User Experience
- Recruitment & HR
- Customer Experience
- Real Estate
- Marketing
- Sales
- Retail & Merchandising
- Science
- Supply Chain Management
- Future Of Work
- Consulting
- Writing
- Economics
- Artificial Intelligence
- Employee Experience
- Workplace Trends
- Fundraising
- Networking
- Corporate Social Responsibility
- Negotiation
- Communication
- Engineering
- Hospitality & Tourism
- Business Strategy
- Change Management
- Organizational Culture
- Design
- Innovation
- Event Planning
- Training & Development