├── .env.example ├── .eslintrc.cjs ├── .github └── workflows │ └── playwright.yml ├── .gitignore ├── LICENSE ├── README.md ├── components.json ├── next.config.mjs ├── package.json ├── playwright.config.ts ├── pnpm-lock.yaml ├── postcss.config.cjs ├── prettier.config.js ├── public └── cover.jpg ├── src ├── actions │ ├── create-comment.ts │ ├── delete-post.ts │ ├── get-user.ts │ ├── helpers │ │ └── revalidate-post.ts │ ├── list-all-posts.ts │ ├── list-issue-comments.ts │ ├── list-my-posts.ts │ └── upsert-post.ts ├── app │ ├── (auth) │ │ ├── layout.tsx │ │ └── posts │ │ │ ├── [id] │ │ │ ├── delete │ │ │ │ └── page.tsx │ │ │ ├── edit │ │ │ │ └── page.tsx │ │ │ └── layout.tsx │ │ │ ├── create │ │ │ └── page.tsx │ │ │ ├── page.tsx │ │ │ └── posts-loader.tsx │ ├── api │ │ ├── auth │ │ │ ├── config.ts │ │ │ ├── logout │ │ │ │ └── route.ts │ │ │ ├── redirect.ts │ │ │ ├── route.ts │ │ │ └── url.ts │ │ └── rss.xml │ │ │ └── route.ts │ ├── error.tsx │ ├── layout.tsx │ ├── page.tsx │ ├── posts │ │ └── [id] │ │ │ ├── comments-loader.tsx │ │ │ ├── loading.tsx │ │ │ └── page.tsx │ └── sitemap.ts ├── common │ ├── action.ts │ ├── github.ts │ └── whitelist.ts ├── components │ ├── author.tsx │ ├── avatar.tsx │ ├── back-button.tsx │ ├── comment.tsx │ ├── form │ │ ├── comment-form-loader.tsx │ │ ├── comment-form.tsx │ │ └── post-form.tsx │ ├── full-page-loader.tsx │ ├── header │ │ ├── header-secondary-title.tsx │ │ ├── header-title.tsx │ │ └── header.tsx │ ├── main-action-button.tsx │ ├── mdx.tsx │ ├── post-helper.tsx │ ├── post-overview.tsx │ ├── posts-container.tsx │ ├── stats.tsx │ ├── submit.tsx │ ├── theme-toggle.tsx │ ├── ui │ │ ├── accordion.tsx │ │ ├── alert.tsx │ │ ├── button.tsx │ │ ├── card.tsx │ │ ├── dropdown-menu.tsx │ │ ├── editor │ │ │ ├── bubble-actions │ │ │ │ ├── link-selector.tsx │ │ │ │ ├── node-selector.tsx │ │ │ │ └── text-buttonts.tsx │ │ │ ├── editor.tsx │ │ │ └── novel-extensions.ts │ │ ├── form.tsx │ │ ├── input.tsx │ │ ├── popover.tsx │ │ ├── select.tsx │ │ ├── separator.tsx │ │ ├── sonner.tsx │ │ └── textarea.tsx │ └── user.tsx ├── env.js ├── hooks │ ├── use-infinite-data.tsx │ └── use-user.ts ├── lib │ ├── action-hook.ts │ ├── theme-script.ts │ └── utils.ts ├── mock │ └── github-server.ts ├── session.ts ├── styles │ └── globals.css └── theme │ └── use-theme.tsx ├── tailwind.config.ts ├── tests └── index.spec.ts └── tsconfig.json /.env.example: -------------------------------------------------------------------------------- 1 | # Github OAuth app credentials 2 | GITHUB_CLIENT_ID= 3 | GITHUB_CLIENT_SECRET= 4 | 5 | # Secret should be at least 32 characters long, generate with `openssl rand -hex 32` 6 | JWT_SECRET= 7 | 8 | # Github repository to store the issues 9 | NEXT_PUBLIC_GITHUB_REPO_OWNER= 10 | NEXT_PUBLIC_GITHUB_REPO= 11 | 12 | # Allowed authors to create posts, separated by comma (i.e. "author1,author2") 13 | WHITELISTED_AUTHORS= 14 | 15 | # Base URL of the app 16 | NEXT_PUBLIC_BASE_URL=http://localhost:3000 17 | 18 | # GitHub token for testing, bypassing rate limits (read README.md for more info) 19 | GITHUB_TOKEN= 20 | -------------------------------------------------------------------------------- /.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | /** @type {import("eslint").Linter.Config} */ 2 | const config = { 3 | parser: "@typescript-eslint/parser", 4 | parserOptions: { 5 | project: true, 6 | }, 7 | plugins: ["@typescript-eslint", "react-compiler"], 8 | extends: [ 9 | "next/core-web-vitals", 10 | "plugin:@typescript-eslint/recommended-type-checked", 11 | "plugin:@typescript-eslint/stylistic-type-checked", 12 | ], 13 | rules: { 14 | // These opinionated rules are enabled in stylistic-type-checked above. 15 | // Feel free to reconfigure them to your own preference. 16 | "@typescript-eslint/array-type": "off", 17 | "@typescript-eslint/consistent-type-definitions": "off", 18 | 19 | "@typescript-eslint/consistent-type-imports": [ 20 | "warn", 21 | { 22 | prefer: "type-imports", 23 | fixStyle: "inline-type-imports", 24 | }, 25 | ], 26 | "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }], 27 | "@typescript-eslint/require-await": "off", 28 | "@typescript-eslint/no-misused-promises": [ 29 | "error", 30 | { 31 | checksVoidReturn: { attributes: false }, 32 | }, 33 | ], 34 | "react-compiler/react-compiler": "error" 35 | }, 36 | }; 37 | 38 | module.exports = config; 39 | -------------------------------------------------------------------------------- /.github/workflows/playwright.yml: -------------------------------------------------------------------------------- 1 | name: Playwright Tests 2 | on: 3 | push: 4 | branches: [main, master] 5 | pull_request: 6 | branches: [main, master] 7 | jobs: 8 | test: 9 | timeout-minutes: 60 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - uses: actions/checkout@v4 14 | 15 | - uses: pnpm/action-setup@v3 16 | with: 17 | version: 9 18 | 19 | - uses: actions/setup-node@v4 20 | with: 21 | node-version: 20 22 | cache: "pnpm" 23 | 24 | - run: pnpm install --frozen-lockfile 25 | 26 | - name: Store Playwright's Version 27 | run: | 28 | PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --json | jq -r '.[0].devDependencies["@playwright/test"].version') 29 | echo "Playwright's Version: $PLAYWRIGHT_VERSION" 30 | echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV 31 | 32 | - name: Cache Playwright Browsers for Playwright's Version 33 | id: cache-playwright-browsers 34 | uses: actions/cache@v4 35 | with: 36 | path: ~/.cache/ms-playwright 37 | key: playwright-browsers-${{ env.PLAYWRIGHT_VERSION }} 38 | 39 | - name: Cache Next.js Build 40 | uses: actions/cache@v4 41 | with: 42 | path: .next 43 | key: nextjs-${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }} 44 | 45 | - name: Setup Playwright 46 | run: pnpm exec playwright install --with-deps 47 | 48 | - name: Run Playwright tests 49 | run: JWT_SECRET=$(openssl rand -hex 32) pnpm test 50 | env: 51 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 52 | 53 | - uses: actions/upload-artifact@v4 54 | if: always() 55 | with: 56 | name: playwright-report 57 | path: playwright-report/ 58 | retention-days: 30 59 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | 11 | # database 12 | /prisma/db.sqlite 13 | /prisma/db.sqlite-journal 14 | 15 | # next.js 16 | /.next/ 17 | /out/ 18 | next-env.d.ts 19 | 20 | # production 21 | /build 22 | 23 | # misc 24 | .DS_Store 25 | *.pem 26 | 27 | # debug 28 | npm-debug.log* 29 | yarn-debug.log* 30 | yarn-error.log* 31 | .pnpm-debug.log* 32 | 33 | # local env files 34 | # do not commit any .env files to git, except for the .env.example file. https://create.t3.gg/en/usage/env-variables#using-environment-variables 35 | .env 36 | .env*.local 37 | 38 | # vercel 39 | .vercel 40 | 41 | # typescript 42 | *.tsbuildinfo 43 | .idea 44 | .vscode 45 | 46 | /test-results/ 47 | /playwright-report/ 48 | /blob-report/ 49 | /playwright/.cache/ 50 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GaaB: GitHub as a Blog 2 | 3 | ![Playwright Tests](https://github.com/kane50613/github-as-a-blog/actions/workflows/playwright.yml/badge.svg) 4 | [![CodeFactor](https://www.codefactor.io/repository/github/kane50613/github-as-a-blog/badge)](https://www.codefactor.io/repository/github/kane50613/github-as-a-blog) 5 | 6 | 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. 7 | 8 | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkane50613%2Fgithub-as-a-blog&env=GITHUB_CLIENT_ID,GITHUB_CLIENT_SECRET,JWT_SECRET,NEXT_PUBLIC_GITHUB_REPO_OWNER,NEXT_PUBLIC_GITHUB_REPO&demo-title=Github%20as%20a%20Blog&demo-description=Effortless%20blogging%20with%20GitHub%20issues%20and%20Next.js&demo-url=https%3A%2F%2Fgithub-as-a-blog.vercel.app%2F&demo-image=https%3A%2F%2Fgithub-as-a-blog.vercel.app%2Fcover.jpg) 9 | 10 | > [!WARNING] 11 | > 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. 12 | 13 | > [!NOTE] 14 | > Refer to the [Setup GitHub OAuth App](#setup-github-oauth-app) section for the environment variables required to run the project. 15 | 16 | - [What problem does GaaB solve?](#what-problem-does-gaab-solve) 17 | - [Technical Details](#technical-details) 18 | - [License](#license) 19 | 20 | ## What problem does GaaB solve? 21 | 22 | GitHub issues is good, but it's still not a perfect place for blogging. GaaB aims to solve the following problems: 23 | 24 | - [SEO](#seo) 25 | - [User Experience](#user-experience) 26 | - [Customization](#customization) 27 | - [Subscription](#subscription) 28 | - [Analytics](#analytics) 29 | - [Security (Whitelisting)](#security-whitelisting) 30 | - [Ownership](#ownership) 31 | - [Performance](#performance) 32 | 33 | ### SEO 34 | 35 | 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. 36 | 37 | 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. 38 | 39 | ### User Experience 40 | 41 | 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. 42 | 43 | With the powerful WYSIWYG editor [novel](https://novel.sh/), users can write blog posts with ease and preview the content in real-time. 44 | 45 | ### Customization 46 | 47 | The website is made with Next.js and [shadcn/ui](https://ui.shadcn.com/) components, which means that you can easily customize the website by forking the repository and modifying the components. 48 | 49 | ### Subscription 50 | 51 | GaaB provides RSS feed through `/api/rss.xml`, users can subscribe to the blog and get notified when new posts are published. 52 | 53 | ### Analytics 54 | 55 | Tracking the performance of your blog is important. GaaB uses [Vercel Analytics](https://vercel.com/analytics) to provide insights into the traffic and performance of your blog. 56 | 57 | You can simply enable Vercel Analytics by heading to the [Vercel dashboard](https://vercel.com/dashboard) and enabling the Analytics feature under the settings of your project. 58 | 59 | If you want to use other analytics service like Cloudflare Web Analytics, you can easily integrate it by yourself. 60 | 61 | ### Security (Whitelisting) 62 | 63 | Since the GitHub repository is public, anyone can create issues and comments. GaaB provides a whitelist feature to prevent spam and abuse. 64 | 65 | By settings the `WHITELISTED_AUTHORS` environment variable in `.env`, separated by commas, only the authors in the whitelist can create issues and comments. 66 | 67 | We also have XSS protection for the content, thanks to the [markdown-to-jsx](https://www.npmjs.com/package/markdown-to-jsx) library, which automatically escapes the HTML in the content and not using `dangerouslySetInnerHTML` directly. 68 | 69 | ### Ownership 70 | 71 | By hosting the content on your own domain, you have full control over the page rendering. 72 | 73 | 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. 74 | 75 | In the future, we may create a migration tool to help you migrate to another platform easily. 76 | 77 | ### Performance 78 | 79 | GaaB is built with Next.js, which provides server-side rendering and static site generation out of the box. 80 | 81 | With the help of CDN and well-optimized caching, the website can be loaded quickly and efficiently. 82 | 83 | [The Lighthouse report](https://pagespeed.web.dev/analysis/https-gaab-yeecord-com-posts-40/8v1v6pfbdl?form_factor=desktop) shows that GaaB has a perfect score of 100 on all metrics, including LCP, FID, CLS, and more. 84 | 85 | ## Technical Details 86 | 87 | - [Tech Stack](#tech-stack) 88 | - [Infinite Scrolling Pagination](#infinite-scrolling-pagination) 89 | - [Safe Server Actions](#safe-server-actions) 90 | - [Setup GitHub OAuth App](#setup-github-oauth-app) 91 | - [Next.js Caching Strategy](#nextjs-caching-strategy) 92 | - [Bypassing the Rate Limit (Optional)](#bypassing-the-rate-limit-optional) 93 | - [Local Development](#local-development) 94 | - [Testing](#testing) 95 | 96 | ### Tech Stack 97 | 98 | - [Next.js](https://nextjs.org/): React framework for server-side rendering and static site generation. 99 | - [create-t3-app](https://create.t3.gg/): The best way to start a full-stack, typesafe Next.js app. 100 | - [shadcn/ui](https://ui.shadcn.com/): A minimalistic UI library for building modern websites. 101 | - [Tailwind CSS](https://tailwindcss.com/): A utility-first CSS framework for rapid UI development. 102 | - [novel](https://novel.sh/): Notion-style WYSIWYG editor. 103 | - [swr](https://swr.vercel.app/): React Hooks library for data fetching. 104 | - [next-safe-action](https://www.npmjs.com/package/next-safe-action): Type safe server actions with validation, error handling, and loading states. 105 | - [react-intersection-observer](https://www.npmjs.com/package/react-intersection-observer): A React component for the Intersection Observer API. 106 | - [markdown-to-jsx](https://www.npmjs.com/package/markdown-to-jsx): The most lightweight, customizable React markdown component. 107 | - [playwright](https://playwright.dev/): Integration testing with Playwright. 108 | 109 | ### Infinite Scrolling Pagination 110 | 111 | GaaB uses infinite scrolling pagination to load more issues when the user scrolls to the bottom of the page. 112 | 113 | The infinite scrolling pagination is implemented with the Intersection Observer API and the `useSWRInfinite` hook from the SWR library. 114 | 115 | Check out the implementation in [`src/hooks/use-infinite-data.tsx`](src/hooks/use-infinite-data.tsx). 116 | 117 | ### Safe Server Actions 118 | 119 | GaaB uses the `next-safe-action` library to handle server actions with validation, error handling, and loading states. 120 | 121 | When errors occur during server actions, the error message is displayed to the user with a toast notification, the [Error boundary](src/app/error.tsx) component catches the error and displays the error message. 122 | 123 | Check out all the server actions in [`src/actions`](src/actions). 124 | 125 | ### Setup GitHub OAuth App 126 | 127 | To use GaaB, you need to create a GitHub OAuth App to authenticate users and fetch the issues from the repository. 128 | 129 | 1. Go to [GitHub Developer Settings](https://github.com/settings/developers), and click on "New OAuth App". 130 | 2. Fill in the required fields: 131 | - Application name: `GaaB` 132 | - Homepage URL: `` 133 | - Authorization callback URL: `/api/auth` 134 | 3. Click on "Register application", and you will get the `Client ID` and `Client Secret`. 135 | 136 | ### Next.js Caching Strategy 137 | 138 | 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](src/hooks/use-user.ts) hook to fetch the user data on the client-side. 139 | 140 | If the page is public, for example, `/posts/[slug]`, [Partial Pre-rendering](https://nextjs.org/docs/app/api-reference/next-config-js/partial-prerendering) is used to speed up the rendering process. 141 | 142 | ### Bypassing the Rate Limit (Optional) 143 | 144 | To bypass the rate limit of the GitHub API, you can [create a personal access token](https://github.com/settings/tokens/new) with the `public_repo` scope and set it as the `GITHUB_TOKEN` environment variable in `.env`. 145 | 146 | > [!WARNING] 147 | > Please keep your personal access token secure and do not expose it to the public. 148 | 149 | ### Local Development 150 | 151 | > [!NOTE] 152 | > Vercel is the recommended way to deploy the project, please refer to the top of the README for the Vercel deployment button. 153 | 154 | To run the project locally, follow the steps below: 155 | 156 | 1. Install [Node.js LTS](https://nodejs.org/), [pnpm 9](https://pnpm.io/installation), and [Git](https://git-scm.com/), `brew install node pnpm git` is the recommended way to install it on macOS. 157 | 2. Clone the repository: 158 | 159 | ```bash 160 | git clone git@github.com:kane50613/github-as-a-blog.git 161 | ``` 162 | 163 | 3. Install the dependencies: 164 | 165 | ```bash 166 | pnpm install 167 | ``` 168 | 169 | 4. Prepare the environment variables: 170 | 171 | ```bash 172 | cp .env.example .env 173 | ``` 174 | 175 | Fill in the environment variables in `.env` with your GitHub OAuth App credentials, and a 32-character random string for the `JWT_SECRET`. 176 | 177 | 5. Run the development server: 178 | 179 | ```bash 180 | pnpm dev 181 | ``` 182 | 183 | ### Testing 184 | 185 | > [!WARNING] 186 | > You should stop the development server before running the tests, as it will build the project and run the tests in production mode. 187 | 188 | > [!NOTE] 189 | > [Mocked versions of the GitHub API](src/mock/github-server.ts) are used in the tests to prevent rate limiting and to make the tests more reliable. 190 | 191 | To run the playwright tests, follow the steps below: 192 | 193 | ```bash 194 | npx playwright install --with-deps 195 | pnpm test 196 | ``` 197 | 198 | ## License 199 | 200 | This project is licensed under the [GPL-3.0 License](LICENSE). 201 | -------------------------------------------------------------------------------- /components.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://ui.shadcn.com/schema.json", 3 | "style": "default", 4 | "rsc": true, 5 | "tsx": true, 6 | "tailwind": { 7 | "config": "tailwind.config.ts", 8 | "css": "src/styles/globals.css", 9 | "baseColor": "slate", 10 | "cssVariables": true, 11 | "prefix": "" 12 | }, 13 | "aliases": { 14 | "components": "@/components", 15 | "utils": "@/lib/utils" 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /next.config.mjs: -------------------------------------------------------------------------------- 1 | /** 2 | * Run `build` or `dev` with `SKIP_ENV_VALIDATION` to skip env validation. This is especially useful 3 | * for Docker builds. 4 | */ 5 | 6 | await import("./src/env.js"); 7 | 8 | /** @type {import("next").NextConfig} */ 9 | const config = { 10 | // disable the `X-Powered-By` header to improve security 11 | poweredByHeader: false, 12 | experimental: { 13 | ppr: true, 14 | reactCompiler: true, 15 | }, 16 | }; 17 | 18 | export default config; 19 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "github-as-a-blog", 3 | "version": "0.1.0", 4 | "private": true, 5 | "type": "module", 6 | "scripts": { 7 | "build": "next build", 8 | "dev": "next dev --turbo", 9 | "lint": "next lint", 10 | "start": "next start", 11 | "test": "playwright test", 12 | "postinstall": "npx simple-git-hooks" 13 | }, 14 | "simple-git-hooks": { 15 | "pre-commit": "npm run lint" 16 | }, 17 | "dependencies": { 18 | "@icons-pack/react-simple-icons": "^9.5.0", 19 | "@octokit/rest": "^21.0.0", 20 | "@radix-ui/react-accordion": "^1.2.0", 21 | "@radix-ui/react-dropdown-menu": "^2.1.1", 22 | "@radix-ui/react-popover": "^1.1.1", 23 | "@radix-ui/react-select": "^2.1.1", 24 | "@radix-ui/react-separator": "^1.1.0", 25 | "@radix-ui/react-slot": "^1.1.0", 26 | "@t3-oss/env-nextjs": "^0.10.1", 27 | "@tiptap/html": "^2.4.0", 28 | "@vercel/analytics": "^1.3.1", 29 | "class-variance-authority": "^0.7.0", 30 | "clsx": "^2.1.1", 31 | "iron-session": "^8.0.2", 32 | "lucide-react": "^0.396.0", 33 | "markdown-to-jsx": "^7.4.7", 34 | "marked": "^13.0.0", 35 | "next": "15.0.0-rc.0", 36 | "next-safe-action": "^7.1.1", 37 | "novel": "^0.4.3", 38 | "react": "19.0.0-rc-3563387fe3-20240621", 39 | "react-dom": "19.0.0-rc-3563387fe3-20240621", 40 | "react-intersection-observer": "^9.10.3", 41 | "remove-markdown": "^0.5.0", 42 | "sonner": "^1.5.0", 43 | "swr": "^2.2.5", 44 | "tailwind-merge": "^2.3.0", 45 | "tailwindcss-animate": "^1.0.7", 46 | "tiptap-markdown": "^0.8.10", 47 | "xss": "^1.0.15", 48 | "zod": "^3.23.8", 49 | "zod-form-data": "^2.0.2", 50 | "zustand": "^4.5.2" 51 | }, 52 | "devDependencies": { 53 | "@faker-js/faker": "^8.4.1", 54 | "@octokit/openapi-types": "^22.2.0", 55 | "@octokit/types": "^13.5.0", 56 | "@playwright/test": "^1.44.1", 57 | "@prettier/plugin-xml": "3.4.1", 58 | "@tailwindcss/typography": "^0.5.13", 59 | "@types/eslint": "^8.56.10", 60 | "@types/node": "^20.14.8", 61 | "@types/react": "^18.3.3", 62 | "@types/react-dom": "^18.3.0", 63 | "@types/remove-markdown": "^0.3.4", 64 | "@typescript-eslint/eslint-plugin": "^7.13.1", 65 | "@typescript-eslint/parser": "^7.13.1", 66 | "babel-plugin-react-compiler": "0.0.0-experimental-938cd9a-20240601", 67 | "eslint": "^8.57.0", 68 | "eslint-config-next": "^14.2.4", 69 | "eslint-plugin-react-compiler": "0.0.0-experimental-c8b3f72-20240517", 70 | "fastify": "^4.28.0", 71 | "postcss": "^8.4.38", 72 | "prettier": "^3.2.5", 73 | "prettier-plugin-embed": "^0.4.15", 74 | "prettier-plugin-organize-imports": "^3.2.4", 75 | "prettier-plugin-tailwindcss": "^0.6.5", 76 | "simple-git-hooks": "^2.11.1", 77 | "tailwindcss": "^3.4.4", 78 | "tsx": "^4.15.7", 79 | "typescript": "^5.4.5" 80 | }, 81 | "ct3aMetadata": { 82 | "initVersion": "7.28.0" 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /playwright.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig, devices } from "@playwright/test"; 2 | 3 | /** 4 | * Read environment variables from file. 5 | * https://github.com/motdotla/dotenv 6 | */ 7 | // require('dotenv').config(); 8 | 9 | /** 10 | * See https://playwright.dev/docs/test-configuration. 11 | */ 12 | export default defineConfig({ 13 | testDir: "./tests", 14 | /* Run tests in files in parallel */ 15 | fullyParallel: true, 16 | /* Fail the build on CI if you accidentally left test.only in the source code. */ 17 | forbidOnly: !!process.env.CI, 18 | retries: 1, 19 | /* Opt out of parallel tests on CI. */ 20 | workers: process.env.CI ? 1 : undefined, 21 | /* Reporter to use. See https://playwright.dev/docs/test-reporters */ 22 | reporter: "list", 23 | /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */ 24 | use: { 25 | /* Base URL to use in actions like `await page.goto('/')`. */ 26 | baseURL: "http://127.0.0.1:3000", 27 | 28 | /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */ 29 | trace: "on-first-retry", 30 | }, 31 | 32 | /* Configure projects for major browsers */ 33 | projects: [ 34 | { 35 | name: "chromium", 36 | use: { ...devices["Desktop Chrome"] }, 37 | }, 38 | 39 | { 40 | name: "firefox", 41 | use: { ...devices["Desktop Firefox"] }, 42 | }, 43 | 44 | { 45 | name: "webkit", 46 | use: { ...devices["Desktop Safari"] }, 47 | }, 48 | 49 | /* Test against mobile viewports. */ 50 | { 51 | name: "Mobile Chrome", 52 | use: { ...devices["Pixel 5"] }, 53 | }, 54 | { 55 | name: "Mobile Safari", 56 | use: { ...devices["iPhone 12"] }, 57 | }, 58 | 59 | /* Test against branded browsers. */ 60 | { 61 | name: "Microsoft Edge", 62 | use: { ...devices["Desktop Edge"], channel: "msedge" }, 63 | }, 64 | { 65 | name: "Google Chrome", 66 | use: { ...devices["Desktop Chrome"], channel: "chrome" }, 67 | }, 68 | ], 69 | 70 | /* Run your local dev server before starting the tests */ 71 | webServer: [ 72 | { 73 | command: "tsx src/mock/github-server.ts", 74 | url: "http://127.0.0.1:3001", 75 | reuseExistingServer: !process.env.CI, 76 | stdout: "pipe", 77 | }, 78 | { 79 | command: "pnpm build && pnpm start", 80 | timeout: 120_000, 81 | url: "http://127.0.0.1:3000", 82 | reuseExistingServer: !process.env.CI, 83 | env: { 84 | NEXT_PUBLIC_GITHUB_REPO_OWNER: "test", 85 | NEXT_PUBLIC_GITHUB_REPO: "test", 86 | GITHUB_CLIENT_ID: "test", 87 | GITHUB_CLIENT_SECRET: "test", 88 | NEXT_PUBLIC_BASE_URL: "http://localhost:3000", 89 | CI: "true", 90 | }, 91 | }, 92 | ], 93 | }); 94 | -------------------------------------------------------------------------------- /postcss.config.cjs: -------------------------------------------------------------------------------- 1 | const config = { 2 | plugins: { 3 | tailwindcss: {}, 4 | }, 5 | }; 6 | 7 | module.exports = config; 8 | -------------------------------------------------------------------------------- /prettier.config.js: -------------------------------------------------------------------------------- 1 | /** @type {import('prettier').Config & import('prettier-plugin-tailwindcss').PluginOptions} */ 2 | const config = { 3 | plugins: [ 4 | "prettier-plugin-tailwindcss", 5 | "prettier-plugin-organize-imports", 6 | "prettier-plugin-embed", 7 | "@prettier/plugin-xml", 8 | ], 9 | }; 10 | 11 | export default config; 12 | -------------------------------------------------------------------------------- /public/cover.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kane50613/github-as-a-blog/18c191ae6af8f0ba02ed280332ca02288b2c4bdf/public/cover.jpg -------------------------------------------------------------------------------- /src/actions/create-comment.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { client } from "@/common/github"; 4 | import { env } from "@/env"; 5 | import { getSession } from "@/session"; 6 | import { z } from "zod"; 7 | import { authAction } from "@/common/action"; 8 | import { zfd } from "zod-form-data"; 9 | 10 | const schema = zfd.formData({ 11 | issue_number: zfd.numeric(), 12 | body: zfd.text(z.string().min(1)), 13 | }); 14 | 15 | export const createComment = authAction 16 | .schema(schema) 17 | .action(async ({ parsedInput: { issue_number, body } }) => { 18 | const session = await getSession(); 19 | 20 | return client(session).issues.createComment({ 21 | owner: env.NEXT_PUBLIC_GITHUB_REPO_OWNER, 22 | repo: env.NEXT_PUBLIC_GITHUB_REPO, 23 | issue_number, 24 | body, 25 | }); 26 | }); 27 | -------------------------------------------------------------------------------- /src/actions/delete-post.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { client, getIssue } from "@/common/github"; 4 | import { env } from "@/env"; 5 | import { notFound, redirect } from "next/navigation"; 6 | import { authAction } from "@/common/action"; 7 | import { z } from "zod"; 8 | import { revalidatePost } from "@/actions/helpers/revalidate-post"; 9 | 10 | export const deletePost = authAction 11 | .schema(z.number()) 12 | .action(async ({ parsedInput, ctx: { session } }) => { 13 | const issue = await getIssue(parsedInput).catch(notFound); 14 | 15 | const result = await client(session).issues.update({ 16 | issue_number: parsedInput, 17 | owner: env.NEXT_PUBLIC_GITHUB_REPO_OWNER, 18 | repo: env.NEXT_PUBLIC_GITHUB_REPO, 19 | state: "closed", 20 | }); 21 | 22 | if (result.data.state !== "closed") 23 | throw new Error("Failed to delete post"); 24 | 25 | revalidatePost(issue); 26 | 27 | redirect("/posts"); 28 | }); 29 | -------------------------------------------------------------------------------- /src/actions/get-user.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { getUser } from "@/common/github"; 4 | import { getUnsafeSession } from "@/session"; 5 | 6 | export async function getUserAction() { 7 | const session = await getUnsafeSession(); 8 | 9 | if (!session.token) return null; 10 | 11 | return getUser(session); 12 | } 13 | -------------------------------------------------------------------------------- /src/actions/helpers/revalidate-post.ts: -------------------------------------------------------------------------------- 1 | import { revalidatePath, revalidateTag } from "next/cache"; 2 | import { type Issue } from "@/common/github"; 3 | 4 | export function revalidatePost(issue: Pick) { 5 | revalidateTag(`posts-${issue.user?.login}`); 6 | revalidateTag(`posts-${issue.number}`); 7 | revalidateTag("posts"); 8 | 9 | revalidatePath(`/posts/${issue.number}`); 10 | } 11 | -------------------------------------------------------------------------------- /src/actions/list-all-posts.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { listPosts as listPostsInternal } from "@/common/github"; 4 | import { action } from "@/common/action"; 5 | import { z } from "zod"; 6 | 7 | export const listAllPosts = action 8 | .schema(z.number()) 9 | .action(async ({ parsedInput }) => listPostsInternal(undefined, parsedInput)); 10 | -------------------------------------------------------------------------------- /src/actions/list-issue-comments.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { client } from "@/common/github"; 4 | import { action } from "@/common/action"; 5 | import { z } from "zod"; 6 | import { env } from "@/env"; 7 | import { getUnsafeSession } from "@/session"; 8 | 9 | const schema = z.object({ 10 | issue_number: z.number(), 11 | page: z.number(), 12 | }); 13 | 14 | export const listIssueComments = action 15 | .schema(schema) 16 | .action(async ({ parsedInput: { issue_number, page } }) => { 17 | const session = await getUnsafeSession(); 18 | 19 | return client(session) 20 | .issues.listComments({ 21 | owner: env.NEXT_PUBLIC_GITHUB_REPO_OWNER, 22 | repo: env.NEXT_PUBLIC_GITHUB_REPO, 23 | issue_number, 24 | per_page: 10, 25 | page, 26 | }) 27 | .then((r) => r.data); 28 | }); 29 | 30 | export type ListIssueComments = NonNullable< 31 | NonNullable>>["data"] 32 | >; 33 | -------------------------------------------------------------------------------- /src/actions/list-my-posts.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { listPosts as listPostsInternal } from "@/common/github"; 4 | import { authAction } from "@/common/action"; 5 | import { z } from "zod"; 6 | 7 | // needs the re-export here with the "use server" directive, otherwise it will not be available in the client 8 | export const listMyPosts = authAction 9 | .schema(z.number()) 10 | .action(async ({ parsedInput, ctx }) => 11 | listPostsInternal(ctx.user.login, parsedInput), 12 | ); 13 | -------------------------------------------------------------------------------- /src/actions/upsert-post.ts: -------------------------------------------------------------------------------- 1 | "use server"; 2 | 3 | import { client } from "@/common/github"; 4 | import { env } from "@/env"; 5 | import { getSession } from "@/session"; 6 | import { redirect } from "next/navigation"; 7 | import { z } from "zod"; 8 | import { zfd } from "zod-form-data"; 9 | import { authAction } from "@/common/action"; 10 | import { revalidatePost } from "@/actions/helpers/revalidate-post"; 11 | 12 | const schema = zfd.formData({ 13 | id: zfd.numeric(z.number().optional()), 14 | title: zfd.text(z.string().min(1)), 15 | body: zfd.text(z.string().min(30)), 16 | }); 17 | 18 | type Schema = z.infer; 19 | 20 | export const upsertPost = authAction 21 | .schema(schema) 22 | .action(async ({ parsedInput: { id, ...data } }) => { 23 | const issue = id ? await updatePost(id, data) : await createPost(data); 24 | 25 | revalidatePost(issue); 26 | 27 | redirect(`/posts/${issue.number}`); 28 | }); 29 | 30 | async function updatePost(id: number, data: Schema) { 31 | const session = await getSession(); 32 | 33 | return client(session) 34 | .issues.update({ 35 | ...data, 36 | issue_number: id, 37 | owner: env.NEXT_PUBLIC_GITHUB_REPO_OWNER, 38 | repo: env.NEXT_PUBLIC_GITHUB_REPO, 39 | }) 40 | .then((r) => r.data); 41 | } 42 | 43 | async function createPost(payload: Schema) { 44 | const session = await getSession(); 45 | 46 | return client(session) 47 | .issues.create({ 48 | ...payload, 49 | owner: env.NEXT_PUBLIC_GITHUB_REPO_OWNER, 50 | repo: env.NEXT_PUBLIC_GITHUB_REPO, 51 | }) 52 | .then((r) => r.data); 53 | } 54 | -------------------------------------------------------------------------------- /src/app/(auth)/layout.tsx: -------------------------------------------------------------------------------- 1 | import { getUser } from "@/common/github"; 2 | import { whitelistCheckWithFallback } from "@/common/whitelist"; 3 | import { getSession } from "@/session"; 4 | import { type ReactNode } from "react"; 5 | 6 | export const runtime = "edge"; 7 | 8 | export default async function Layout({ children }: { children: ReactNode }) { 9 | const session = await getSession(); 10 | 11 | const user = await getUser(session); 12 | 13 | if (!whitelistCheckWithFallback(user.login)) 14 | return ( 15 |
16 |

Forbidden

17 |

18 | You are not allowed to access this page, please contact the owner of 19 | the blog. 20 |

21 |
22 | ); 23 | 24 | return <>{children}; 25 | } 26 | -------------------------------------------------------------------------------- /src/app/(auth)/posts/[id]/delete/page.tsx: -------------------------------------------------------------------------------- 1 | import { deletePost } from "@/actions/delete-post"; 2 | import { getIssue } from "@/common/github"; 3 | import { Submit } from "@/components/submit"; 4 | import { Button } from "@/components/ui/button"; 5 | import { Trash } from "lucide-react"; 6 | import Link from "next/link"; 7 | import { notFound } from "next/navigation"; 8 | 9 | export default async function Page({ 10 | params: { id }, 11 | }: { 12 | params: { id: string }; 13 | }) { 14 | const issue = await getIssue(parseInt(id)).catch(notFound); 15 | 16 | return ( 17 |
21 |

Are you sure you want to delete this post?

22 |

{issue.title}

23 |
24 | 27 | 28 | 29 | Yes 30 | 31 |
32 |
33 | ); 34 | } 35 | -------------------------------------------------------------------------------- /src/app/(auth)/posts/[id]/edit/page.tsx: -------------------------------------------------------------------------------- 1 | import { getIssue } from "@/common/github"; 2 | import { PostForm } from "@/components/form/post-form"; 3 | import { BackButton } from "@/components/back-button"; 4 | 5 | export default async function Page({ 6 | params: { id }, 7 | }: { 8 | params: { id: string }; 9 | }) { 10 | const issue = await getIssue(parseInt(id)); 11 | 12 | return ( 13 |
14 | Back to Post 15 |

Edit Post

16 | 23 |
24 | ); 25 | } 26 | -------------------------------------------------------------------------------- /src/app/(auth)/posts/[id]/layout.tsx: -------------------------------------------------------------------------------- 1 | import { getIssue, getUser } from "@/common/github"; 2 | import { getSession } from "@/session"; 3 | import { notFound, redirect } from "next/navigation"; 4 | import { type ReactNode } from "react"; 5 | 6 | export default async function Layout({ 7 | children, 8 | params: { id }, 9 | }: { 10 | children: ReactNode; 11 | params: { id: string }; 12 | }) { 13 | if (!Number(id)) notFound(); 14 | 15 | const session = await getSession(); 16 | 17 | const user = await getUser(session); 18 | 19 | const issue = await getIssue(parseInt(id)).catch(notFound); 20 | 21 | if (issue.closed_at ?? issue.user?.login !== user.login) 22 | redirect(`/posts/${id}`); 23 | 24 | return <>{children}; 25 | } 26 | -------------------------------------------------------------------------------- /src/app/(auth)/posts/create/page.tsx: -------------------------------------------------------------------------------- 1 | import { PostForm } from "@/components/form/post-form"; 2 | import { BackButton } from "@/components/back-button"; 3 | 4 | export default async function Page() { 5 | return ( 6 |
7 | Back to My Posts 8 |

Create Post

9 | 10 |
11 | ); 12 | } 13 | -------------------------------------------------------------------------------- /src/app/(auth)/posts/page.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | import { PostsLoader } from "@/app/(auth)/posts/posts-loader"; 4 | import { Button } from "@/components/ui/button"; 5 | import { Separator } from "@/components/ui/separator"; 6 | import { env } from "@/env"; 7 | import { Plus } from "lucide-react"; 8 | import Link from "next/link"; 9 | import { HeaderTitle } from "@/components/header/header-title"; 10 | 11 | export default function Page() { 12 | return ( 13 |
14 |
15 | 16 |
17 |

My Posts

18 | 24 |
25 |

26 | This page shows the posts you have created in{" "} 27 | 32 | {env.NEXT_PUBLIC_GITHUB_REPO_OWNER}/{env.NEXT_PUBLIC_GITHUB_REPO} 33 | 34 | . 35 |

36 |
37 | 38 | 39 |
40 | ); 41 | } 42 | -------------------------------------------------------------------------------- /src/app/(auth)/posts/posts-loader.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | import type { Post } from "@/common/github"; 4 | import { PostOverview } from "@/components/post-overview"; 5 | import { PostsContainer } from "@/components/posts-container"; 6 | import { useInfiniteData } from "@/hooks/use-infinite-data"; 7 | import { Loader2 } from "lucide-react"; 8 | import { listMyPosts } from "@/actions/list-my-posts"; 9 | import { listAllPosts } from "@/actions/list-all-posts"; 10 | import { wrapInfiniteSafeAction } from "@/lib/action-hook"; 11 | 12 | export const PostsLoader = ({ type }: { type: "all" | "mine" }) => { 13 | const loader = wrapInfiniteSafeAction( 14 | type === "all" ? listAllPosts : listMyPosts, 15 | ); 16 | 17 | const { ref, components, isLoading, hasMore } = useInfiniteData({ 18 | loader, 19 | render: (post) => , 20 | key: type, 21 | }); 22 | 23 | return ( 24 | <> 25 | {components} 26 |
27 | {isLoading && ( 28 |
29 | Loading posts... 30 |
31 | )} 32 | {!hasMore && !isLoading && ( 33 |
34 |

No more posts

35 |
36 | )} 37 | 38 | ); 39 | }; 40 | -------------------------------------------------------------------------------- /src/app/api/auth/config.ts: -------------------------------------------------------------------------------- 1 | import { env } from "@/env"; 2 | 3 | export const loginUrl = new URL("https://github.com/login/oauth/authorize"); 4 | 5 | export const scopes = ["read:user", "public_repo"]; 6 | export const scope = scopes.join(" "); 7 | 8 | loginUrl.searchParams.set("client_id", env.GITHUB_CLIENT_ID); 9 | loginUrl.searchParams.set("response_type", "code"); 10 | loginUrl.searchParams.set("scope", scope); 11 | -------------------------------------------------------------------------------- /src/app/api/auth/logout/route.ts: -------------------------------------------------------------------------------- 1 | import { getUnsafeSession } from "@/session"; 2 | 3 | export async function GET(req: Request) { 4 | const session = await getUnsafeSession(); 5 | 6 | session.destroy(); 7 | 8 | const url = new URL(req.url); 9 | 10 | return Response.redirect(`${url.protocol}//${url.host}`); 11 | } 12 | -------------------------------------------------------------------------------- /src/app/api/auth/redirect.ts: -------------------------------------------------------------------------------- 1 | import { cookies } from "next/headers"; 2 | import { getUnsafeSession } from "@/session"; 3 | import { buildFullUrl } from "@/app/api/auth/url"; 4 | import { loginUrl } from "@/app/api/auth/config"; 5 | 6 | export async function redirectToGithub(req: Request) { 7 | const state = Math.random().toString(36).slice(2); 8 | 9 | const referer = req.headers.get("referer"); 10 | 11 | if (referer) cookies().set("rd", new URL(referer).pathname); 12 | 13 | const session = await getUnsafeSession(); 14 | 15 | session.state = state; 16 | 17 | await session.save(); 18 | 19 | const url = new URL(loginUrl); 20 | 21 | url.searchParams.set("redirect_uri", buildFullUrl(req, "/api/auth")); 22 | url.searchParams.set("state", state); 23 | 24 | return Response.redirect(url, 302); 25 | } 26 | 27 | export function redirectFromCookie(req: Request) { 28 | const store = cookies(); 29 | 30 | const redirectCookie = store.get("rd")?.value; 31 | 32 | try { 33 | store.delete("rd"); 34 | } catch (e) {} 35 | 36 | if ( 37 | redirectCookie && 38 | /^\/([^?\/]+)/gm.test(redirectCookie) && 39 | !redirectCookie.includes("/api/auth") 40 | ) 41 | return Response.redirect(buildFullUrl(req, redirectCookie), 302); 42 | 43 | return Response.redirect(buildFullUrl(req, "/posts"), 302); 44 | } 45 | -------------------------------------------------------------------------------- /src/app/api/auth/route.ts: -------------------------------------------------------------------------------- 1 | import { env } from "@/env"; 2 | import { getUnsafeSession } from "@/session"; 3 | import { scope, scopes } from "@/app/api/auth/config"; 4 | import { redirectFromCookie, redirectToGithub } from "@/app/api/auth/redirect"; 5 | 6 | export const runtime = "edge"; 7 | 8 | export async function GET(req: Request) { 9 | // Simulate real user interaction signing in with GitHub 10 | if (process.env.CI) { 11 | const session = await getUnsafeSession(); 12 | 13 | session.state = "TEST"; 14 | 15 | await session.save(); 16 | 17 | const url = new URL(req.url); 18 | 19 | url.pathname = "/api/auth"; 20 | url.searchParams.set("code", "TEST"); 21 | url.searchParams.set("scope", scope); 22 | url.searchParams.set("state", "TEST"); 23 | 24 | const request = new Request(url); 25 | 26 | return grabToken(request, "TEST"); 27 | } 28 | 29 | const code = new URL(req.url).searchParams.get("code"); 30 | 31 | if (code) return grabToken(req, code); 32 | 33 | return redirectToGithub(req); 34 | } 35 | 36 | async function grabToken(req: Request, code: string) { 37 | const session = await getUnsafeSession(); 38 | 39 | const params = new URL(req.url).searchParams; 40 | 41 | if (params.get("state") !== session.state) return redirectToGithub(req); 42 | 43 | const token = await exchangeToken(req, code); 44 | 45 | if ("error" in token) throw new Error(JSON.stringify(token)); 46 | 47 | const givenScopes = token.scope.match(/[a-z:_]+/g) ?? []; 48 | 49 | if ( 50 | givenScopes.length !== scopes.length || 51 | !givenScopes.every((scope) => scopes.includes(scope)) 52 | ) 53 | return redirectToGithub(req); 54 | 55 | session.token = token.access_token; 56 | 57 | await session.save(); 58 | 59 | if (!session.token) return redirectToGithub(req); 60 | 61 | return redirectFromCookie(req); 62 | } 63 | 64 | async function exchangeToken(req: Request, code: string) { 65 | if (process.env.CI) { 66 | if (!env.GITHUB_TOKEN) throw new Error("GITHUB_TOKEN is not set in CI"); 67 | 68 | if (code !== "TEST") throw new Error("Code is not set to TEST in CI"); 69 | 70 | return { 71 | access_token: env.GITHUB_TOKEN, 72 | scope, 73 | }; 74 | } 75 | 76 | const { protocol, host } = new URL(req.url); 77 | 78 | const tokenRequest = await fetch( 79 | "https://github.com/login/oauth/access_token", 80 | { 81 | method: "POST", 82 | headers: { 83 | "Content-Type": "application/json", 84 | Accept: "application/json", 85 | }, 86 | body: JSON.stringify({ 87 | client_id: env.GITHUB_CLIENT_ID, 88 | client_secret: env.GITHUB_CLIENT_SECRET, 89 | code, 90 | redirect_uri: `${protocol}//${host}/api/auth`, 91 | }), 92 | }, 93 | ); 94 | 95 | return (await tokenRequest.json()) as 96 | | { 97 | access_token: string; 98 | scope: string; 99 | } 100 | | { 101 | error: string; 102 | }; 103 | } 104 | -------------------------------------------------------------------------------- /src/app/api/auth/url.ts: -------------------------------------------------------------------------------- 1 | export function buildFullUrl(req: Request, path: string) { 2 | const { protocol, host } = new URL(req.url); 3 | 4 | return `${protocol}//${host}${path}`; 5 | } 6 | -------------------------------------------------------------------------------- /src/app/api/rss.xml/route.ts: -------------------------------------------------------------------------------- 1 | import { listAllPosts } from "@/common/github"; 2 | import { env } from "@/env"; 3 | import removeMarkdown from "remove-markdown"; 4 | 5 | export const runtime = "edge"; 6 | export const revalidate = 60; 7 | 8 | export async function GET() { 9 | const posts = await listAllPosts(); 10 | 11 | const latestDate = new Date(posts[0]?.updated_at ?? Date.now()); 12 | 13 | const postsXml = posts 14 | .map( 15 | (post) => /* xml */ ` 16 | ${escapeXml(post.title)} 17 | ${env.NEXT_PUBLIC_BASE_URL}/posts/${post.number} 18 | ${new Date(post.updated_at).toUTCString()} 19 | ${ 20 | post.body ? escapeXml(removeMarkdown(post.body)) : "" 21 | } 22 | ${env.NEXT_PUBLIC_BASE_URL}/posts/${post.number} 23 | `, 24 | ) 25 | .join("\n"); 26 | 27 | const feed = /* xml */ ` 28 | 29 | 30 | GitHub as a Blog 31 | GitHub as a Blog 32 | ${env.NEXT_PUBLIC_BASE_URL} 33 | en 34 | 35 | ${env.NEXT_PUBLIC_BASE_URL}/cover.jpg 36 | GitHub as a Blog 37 | ${env.NEXT_PUBLIC_BASE_URL} 38 | 39 | ${latestDate.toUTCString()} 40 | ${latestDate.toUTCString()} 41 | 60 42 | 47 | ${postsXml} 48 | 49 | `; 50 | 51 | return new Response(feed, { 52 | headers: { 53 | "content-type": "application/rss+xml", 54 | }, 55 | }); 56 | } 57 | 58 | // directly putting raw post body is super dangerous, we have to escape xml symbols 59 | function escapeXml(unsafe: string) { 60 | return unsafe 61 | .replace(/&/g, "&") 62 | .replace(//g, ">") 64 | .replace(/"/g, """) 65 | .replace(/'/g, "'"); 66 | } 67 | -------------------------------------------------------------------------------- /src/app/error.tsx: -------------------------------------------------------------------------------- 1 | "use client"; 2 | 3 | import { themeScript } from "@/lib/theme-script"; 4 | import Error from "next/error"; 5 | import { useEffect } from "react"; 6 | import { toast } from "sonner"; 7 | 8 | export default function GlobalError({ error }: { error: unknown }) { 9 | useEffect(() => { 10 | console.error(error); 11 | toast.error("An error occurred. Please try again later."); 12 | }, [error]); 13 | 14 | return ( 15 | 16 | 17 |