lifetracker/apps/docs/docs/how-i-built-this/02-hygiene.md

33 lines
1.3 KiB
Markdown

---
description: Time to actually do shit.
---
# Repo Hygiene
So you got a project started and wasted some time writing documentation. Great!
Now, let's move on to "actually building software that does something" and "everything else other than running a generator and writing useless documentation".
## But first, wtf is @repo?
Let's change all the auto-generated `@repo` references to `@lifetracker`. To do this, I am about to use VSCode's Find and Replace feature.
Yeah, I know, mind blowing stuff so far.
But, keep in mind, I have Typescript server running and I'm able to load `localhost:3000` and `localhost:3001` without errors. Will everything break as soon as I make these changes?
:::info
Yes, everything worked fine as soon as I made the ~31 edits, ran `pnpm install`, restarted the Typescript server, and re-ran `pnpm dev`.
:::
## Another side-quest: Git Repository
There's really no reason to document this. I already had a local a git repo initialized (can't remember if this happens by default in my `init-nix` script, or if I ran `git init`, you're on your own); I created a cloud copy on `git.ryanpandya.com` and synced all this crap with it.
:::note
Make sure you de-select "Initialize repository" so that the first commit from VSCode actually goes through instead of causing a mountain of sync conflicts and merge headaches.
:::