Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Notebook Archive 2.0 #13

Merged
merged 25 commits into from
Jan 18, 2023
Merged

Notebook Archive 2.0 #13

merged 25 commits into from
Jan 18, 2023

Conversation

qjack001
Copy link
Member

Ok so a pretty big update in terms of code, but I'll give you the spark notes:

  • the old version used Vue 2 with Vue Router, etc, and was getting old and crufty
  • the set up required the developer to explicitly write down in a JSON file how many pages the notebook had and any other information, for each notebook
  • the developer also needed to hard-code in the number of notebooks
  • making large updates to the theme/style of the site was not particularly easy
  • design looked slightly dated
  • the site was not (well-done) responsive
  • there were some visual bugs (notebook page could get larger than screen, everything was smushed to the top)
  • the load times were not great (heavy images, JS, mp3 files)

The main fix here is switching to Astro as the base framework. I've come up with a new system for adding and organizing the notebooks, allowing them to be loaded automatically (and with all their metadata, like start/complete dates). I'll update the README to explain this process better.

Other than that, I've re-written everything from scratch, checking off most of the issues listed above. I'm not sure exactly how you can browse the update (other than cloning the branch and running locally) — the Vercel build is not configured to build the preview branch given this new set up. In leu of that, here are some comparisons in terms of the page design:

Old homepage vs New homepage

With the 3rd notebook hovered:

Old homepage screenshotNew homepage screenshot

Old notebook page vs New notebook page

On page zero (aka, the cover):

Old notebook page screenshotNew notebook page screenshot

Old mobile-sized notebook page vs New mobile-sized notebook page

Old mobile-sized  notebook page screenshotNew mobile-sized  notebook page screenshot

Ongoing, todos, and regressions

These code changes remove some of the previous functionality of the site (#9), which we may or may not wish to re-implement (#10, #11) . As well, there continue to be things I'd like to add that this does not address (#6), and new issues these changes create (#12).

@vercel
Copy link

vercel bot commented Jan 17, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
field-notes-archive ❌ Failed (Inspect) Jan 17, 2023 at 9:11AM (UTC)

@@ -0,0 +1,50 @@
<!DOCTYPE html>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This component attempts to be the "theme editor" if you will. Meta tags, page title, colour scheme, and fonts are all defined here as the developer may wish.

@maxkele
Copy link

maxkele commented Jan 18, 2023

When sorting old to new is it using the start of the finished date?

@qjack001
Copy link
Member Author

When sorting old to new is it using the start of the finished date?

In both cases (OLD to NEW and NEW to OLD), the sorting is based on start date. Your oldest notebook is the one you started first, even if you're still using it and others have been completed.

const { condition } = Astro.props as { condition: boolean }
---
{
condition && <slot/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha the best 😝

@qjack001 qjack001 merged commit d48a495 into main Jan 18, 2023
@qjack001 qjack001 deleted the astro-update branch January 18, 2023 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants