Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
GeertRoks committed Nov 13, 2024
1 parent 06733e6 commit e31d474
Showing 1 changed file with 46 additions and 70 deletions.
116 changes: 46 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,52 @@
# PersonalWebsite
The source code for my personal website: www.geertroks.com. Build with NuxtJS, Nuxt Content and TailwindCSS.
The source code for my personal website: www.geertroks.com, built using Nuxt 3, Nuxt Content and TailwindCSS. This site is designed to be simple and professional, yet playful to reflect my personality. It's main goal is to showcase my portfolio, but it also supports a blog section to share specific things I have learned.

## To Do
#### Development
- [x] clickable tags
- [x] make a tag component
- [x] projects page filtering via query
- [x] rewrite tag query to tag path
- [x] footer
- [x] integrate more of primary color into projects, single project and contact pages
- [x] Make projects load staticaly on the server (ie. remove client-only tags, but without the hydration error popping up) -> only shows in dev mode, so no problem
- [x] fix card date (move it to right upper corner, just below the image)
- [x] fix nav bar scroll issue with long scrolls
- [x] make copyright year dependent on current year
- [x] fix tag overflow from cards
- [x] mobile friendly site
- [x] make nav bar take less height in mobile view
- [x] make project page image take less height in mobile view
- [x] give text a little margin in mobile view
- [x] fix navbar mobile menu drop down behavior into overlay behavior
- [x] fix footer in mobile form
- [x] homepage avatar above name in mobile view
- [x] migrate to nuxt v3 when stable
- [ ] make contact form operational
- [x] add option to disable contact page, site-wide
- [ ] send data to email
- [ ] setup form endpoint (formspree.io? or selfhosted?)
- [ ] OR develop an endpoint yourself
- [ ] Setup database (mongodb of SQL)
- [ ] setup UI like a mail service
- [ ] filter spam/malicious form entries using regex or already existing service
- [ ] email notifications of new messages
- [ ] make it a separate git project, so others can use it as well
- [x] Media support for project pages
- [x] video support
- [x] mp4
- [x] Youtube
- [x] image support
- [x] jpg
- [x] Gallery option
- [x] size option (max-width, max-height) -> using MDC syntax and tailwind classes
- [x] placement options (left, right, center) -> using MDC syntax and tailwind classes
- [x] audio support
- [x] mp3
- [ ] Add Gitlab component
- [x] clickable tags
- [x] make a tag component
- [x] projects page filtering via query
- [x] rewrite tag query to tag path
- [x] footer
- [x] mobile friendly site
- [x] make navbar take less height in mobile view
- [x] make project page image take less height in mobile view
- [x] give text a little margin in mobile view
- [x] fix navbar mobile menu drop down behavior into overlay behavior
- [x] fix footer in mobile form
- [x] homepage avatar above name in mobile view
- [ ] contact form
- [x] add option to disable contact page, site-wide
- [ ] send data to email
- [ ] setup form endpoint (formspree.io? or selfhosted?)
- [ ] OR develop an endpoint yourself
- [ ] Setup database (mongodb of SQL)
- [ ] setup UI like a mail service
- [ ] filter spam/malicious form entries using regex or already existing service
- [ ] email notifications of new messages
- [ ] make it a separate git project, so others can use it as well
- [x] Media support for project pages
- [x] video support
- [x] mp4
- [x] YouTube
- [x] image support
- [x] jpg
- [x] Gallery option
- [x] size option (max-width, max-height) -> using MDC syntax and tailwind classes
- [x] placement options (left, right, center) -> using MDC syntax and tailwind classes
- [x] audio support
- [x] mp3
- [x] Add Gitlab component
- [x] add blog
- [x] dockerize project
- [x] dockerize nuxt project
- [x] dockerize static file server
- [x] orgestrate with docker compose
- [x] use `.env` file for settings
- [x] add image server location
- [x] GitHub actions for automatic updating of content to server

- optional:
- [ ] project view next/prev project if it is a series. Add a line under the article and then two buttons
- [ ] Let navbar disapear when scrolling long, so more room for reading, but reapear when scrolling up (firefox app style)
- [ ] add blog
- optional:
- [ ] project view next/prev project if it is a series. Add a line under the article and then two buttons
- [ ] Let navbar disappear when scrolling long, so more room for reading, but reappear when scrolling up (Firefox app style)

#### Production:
- [ ] write content
- [x] dockerize project
- [x] dockerize nuxt project
- [x] dockerize static file server
- [x] orgestrate with docker compose
- [x] use `.env` file for settings
- [x] add image server location
- [ ] GitHub actions for automatic updating of content to server


### Color feedback
- all buttons same color + hover
- line under navbar
- hover over navbar elements + color for active page
- line under headings for extra color
- hover over social buttons (same as local links)
- footer white for less attention
- buttons under project page for other projects and back to all projects
- tags not clickable in cards, but use a filter on top
- Social buttons svg gray-100 (same as background)
- headers left allign or center?
- vertical line left next to homepage title/about for accent (possiblity)
- contact page: alternative layout with 2/3 contact form on left and picture on right

0 comments on commit e31d474

Please sign in to comment.