Skip to content

Latest commit

 

History

History
200 lines (125 loc) · 9.52 KB

README.md

File metadata and controls

200 lines (125 loc) · 9.52 KB
Raw

GaaB: GitHub as a Blog

Playwright Tests CodeFactor

This project, developed as part of a Dcard internship assignment, aims to transform GitHub issues into blog posts for seamless content sharing and search engine optimization (SEO) improvement.

Deploy with Vercel

Warning

By default, when forking the repository, the issues feature is disabled. You need to enable it by going to the repository settings and enabling the issues feature.

Note

Refer to the Setup GitHub OAuth App section for the environment variables required to run the project.

What problem does GaaB solve?

GitHub issues is good, but it's still not a perfect place for blogging. GaaB aims to solve the following problems:

SEO

The content in GitHub issues is not indexed by search engines always, which means that the content is not discoverable and hard to gain organic traffic.

By self-hosting the content with GaaB on your own domain, it can be more professional and SEO-friendly because we use Next.js to generate server-side rendered pages with low latency.

User Experience

GitHub issues is designed for issue tracking, with a lot of features that are not necessary for blogging. GaaB provides a clean and minimalistic interface for reading and writing blog posts.

With the powerful WYSIWYG editor novel, users can write blog posts with ease and preview the content in real-time.

Customization

The website is made with Next.js and shadcn/ui components, which means that you can easily customize the website by forking the repository and modifying the components.

Subscription

GaaB provides RSS feed through /api/rss.xml, users can subscribe to the blog and get notified when new posts are published.

Analytics

Tracking the performance of your blog is important. GaaB uses Vercel Analytics to provide insights into the traffic and performance of your blog.

You can simply enable Vercel Analytics by heading to the Vercel dashboard and enabling the Analytics feature under the settings of your project.

If you want to use other analytics service like Cloudflare Web Analytics, you can easily integrate it by yourself.

Security (Whitelisting)

Since the GitHub repository is public, anyone can create issues and comments. GaaB provides a whitelist feature to prevent spam and abuse.

By settings the WHITELISTED_AUTHORS environment variable in .env, separated by commas, only the authors in the whitelist can create issues and comments.

We also have XSS protection for the content, thanks to the markdown-to-jsx library, which automatically escapes the HTML in the content and not using dangerouslySetInnerHTML directly.

Ownership

By hosting the content on your own domain, you have full control over the page rendering.

We do not host any content, and the content is fetched from GitHub's API directly. This means that you can easily migrate to another platform without losing any content.

In the future, we may create a migration tool to help you migrate to another platform easily.

Performance

GaaB is built with Next.js, which provides server-side rendering and static site generation out of the box.

With the help of CDN and well-optimized caching, the website can be loaded quickly and efficiently.

The Lighthouse report shows that GaaB has a perfect score of 100 on all metrics, including LCP, FID, CLS, and more.

Technical Details

Tech Stack

  • Next.js: React framework for server-side rendering and static site generation.
  • create-t3-app: The best way to start a full-stack, typesafe Next.js app.
  • shadcn/ui: A minimalistic UI library for building modern websites.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • novel: Notion-style WYSIWYG editor.
  • swr: React Hooks library for data fetching.
  • next-safe-action: Type safe server actions with validation, error handling, and loading states.
  • react-intersection-observer: A React component for the Intersection Observer API.
  • markdown-to-jsx: The most lightweight, customizable React markdown component.
  • playwright: Integration testing with Playwright.

Infinite Scrolling Pagination

GaaB uses infinite scrolling pagination to load more issues when the user scrolls to the bottom of the page.

The infinite scrolling pagination is implemented with the Intersection Observer API and the useSWRInfinite hook from the SWR library.

Check out the implementation in src/hooks/use-infinite-data.tsx.

Safe Server Actions

GaaB uses the next-safe-action library to handle server actions with validation, error handling, and loading states.

When errors occur during server actions, the error message is displayed to the user with a toast notification, the Error boundary component catches the error and displays the error message.

Check out all the server actions in src/actions.

Setup GitHub OAuth App

To use GaaB, you need to create a GitHub OAuth App to authenticate users and fetch the issues from the repository.

  1. Go to GitHub Developer Settings, and click on "New OAuth App".
  2. Fill in the required fields:
    • Application name: GaaB
    • Homepage URL: <Base URL of your website>
    • Authorization callback URL: <Base URL of your website>/api/auth
  3. Click on "Register application", and you will get the Client ID and Client Secret.

Next.js Caching Strategy

To adhere to Next.js caching rules, dynamic functions, such as getUser, must be converted into server actions to resolve the issue, using the useUser hook to fetch the user data on the client-side.

If the page is public, for example, /posts/[slug], Partial Pre-rendering is used to speed up the rendering process.

Bypassing the Rate Limit (Optional)

To bypass the rate limit of the GitHub API, you can create a personal access token with the public_repo scope and set it as the GITHUB_TOKEN environment variable in .env.

Warning

Please keep your personal access token secure and do not expose it to the public.

Local Development

Note

Vercel is the recommended way to deploy the project, please refer to the top of the README for the Vercel deployment button.

To run the project locally, follow the steps below:

  1. Install Node.js LTS, pnpm 9, and Git, brew install node pnpm git is the recommended way to install it on macOS.

  2. Clone the repository:

    git clone git@github.com:kane50613/github-as-a-blog.git

  3. Install the dependencies:

    pnpm install

  4. Prepare the environment variables:

    cp .env.example .env

    Fill in the environment variables in .env with your GitHub OAuth App credentials, and a 32-character random string for the JWT_SECRET.

  5. Run the development server:

    pnpm dev

Testing

Warning

You should stop the development server before running the tests, as it will build the project and run the tests in production mode.

Note

Mocked versions of the GitHub API are used in the tests to prevent rate limiting and to make the tests more reliable.

To run the playwright tests, follow the steps below:

npx playwright install --with-deps
pnpm test

License

This project is licensed under the GPL-3.0 License.