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.
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.
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 react-markdown 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.
Local Development
To run the project locally, follow the steps below:
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.
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.
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_AUTHORSenvironment 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 react-markdown library, which automatically escapes the HTML in the content and not using
dangerouslySetInnerHTMLdirectly.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.
Local Development
To run the project locally, follow the steps below:
Clone the repository:
Install the dependencies:
Prepare the environment variables:
Fill in the environment variables in
.envwith your GitHub OAuth App credentials, and a secret key for encrypting the session token.Run the development server: