šŸ‘¶ Birth of Jermainecheng.com

JC

Jermaine Cheng /

This platform was built as an experiment to start journaling my experiences in the software industry. I needed a space to scribble down my thought processes so I have a resource for the next time I have to do it again.

This was also a good way for me to build an online presence ā€” Iā€™m trying to slowly move away from Facebook and Instagram but still want to be able to share parts of my life with friends and family ā¤ļø.

If you want to start something similar, I strongly suggest using this or Lee Robinson's Blog as a starter template and use this blog post as a resource to understand the thought process of creating this codebase.

The file structure of the repository can be broken into 6 parts:

  1. pages/api/* ā€” API routes for server side content.
  2. pages/* ā€” Pages for the application, the application routing is built into the file structure (no code needed).
  3. blogs/* ā€” Markdown files serving the content for the statically generated pages and paths in /pages/blogs/[id].js.
  4. components/* ā€” React components.
  5. lib/* ā€” Helper functions / methods.
  6. public/* ā€” Any assets that should be served by next goes here.

This blog is built with these libraries / frameworks:

  1. NextJS ā€” A framework that allows you to run a statically rendered React application with microservices. It takes into consideration best practices of running React so we don't have to worry about configuring and the process of the transpilation / compilation process (i.e babel, webpacker). If you have not created a nextjs application before, I would strongly recommend following their tutorial. The tutorial clearly explains how files should be organized and caveats in the ecosystem (some namespaces are reserved for running a backend with nextjs).
  2. ESlint / Prettier ā€” The default linters for catching buggy code and code styles respectively. These are not necessary but it makes the codebase alot nicer to work with
  3. Emotion ā€” A popular CSS in JS option. This allows tighter css integration with code which works well if you are considering doing programmatic style transitions like dark mode.
  4. Chakra UI ā€” A styleguide; Chakra UI is a great choice since it helps to define media breakpoints, color modes and style props. It is well designed and provides the atomic building blocks instead of UI components. This provides alot more flexibilty and customization when building the frontend.
  5. Remark / Gray-matter ā€” These are markdown parsers that are able to convert markdown into .jsx elements and extract front matter content.This parsers are what allows you to write a blog in markdown and transforming it into a styled webpage.
Subscribe to the newsletter

Get early access to new articles.

Discuss on Twitter ā€¢ Edit on GitHub

Made with ā¤ļø by Jermaine; Inspired by Lee Robinson