Description
An umbrella project for all my personal stuff.
Architecture Decision Records
Posts
To do
- Husky for git hooks
- ESLint on commit
- Run E2E on push
- Define what you want to achieve with this
- Set up Github pages with Jekyll
- Add Renovate
- Get Jekyll working locallyz
- Fix URL prefix missing bug
- Add link to Github pages in Readme.md
- Run build in Github Actions
- Add link to Github pages on application landing page
- Fix VSCode Jest integration
- Continue with first steps
- Start building some features
Goals
Establish a project that you will keep adding to and make use of by:
- Making it effortless to add to
- Making it joyful to work with
- Making it genuinely useful
- Making it easily extendable
Principles
- Working beats good, good enough beats perfect
- The goal is always good code but I’m working within constraints and its more valuable to have bad code that does the thing than good code that’s never finished. Get it working, then add tasks to refine and get it to good if you like. You’re going to get more out of having useful features than refining code to perfection, so when it’s ‘good enough’ move on.
- Everything in baby steps
- I’m going to be time constrained when I’m working with this, I might get half an hour to and hour at a time typically, so I should break down the work into the smallest commits I possibly can so that I’m able to consistently nudge it forward. By maintaining progress it’ll be a happier experience to work with it.
- Making hard things easy beats doing hard things
- This is partly a sandbox for testing new techniques and tools that make the development process as a whole smoother. I should do linting, static analysis, hooks, CI etc and do it deliberately and early to catch as many issues as I can before they become issues. Furthermore this should be joyful to work with - so if something is hard and unpleasant, stop doing it and find a better way.
Features
- Add AI generated logo
- Basic blogging capability in Markdown
- Widget showing current Carbon intensity
- Get some values back
- Make it look pretty (ish)
- Provide appropriate nudges to document stuff (see ADR 001 - Use ADRs)
- Functional and aesthetically pleasing UI
- Only run tests if relevant folders have changed
- Blog linting
- Private posts
- Cloud hosting