lihqi/gh-next

A minimal Github clone built on nextjs app router.

A clone of github* in Next.JS

* only some features are implemented : issues CRUD & notifications

⚠️ THIS PROJECT IS IN ACTIVE DEVELOPMENT !!

Expect stuff to break.

Roadmap

• Login/Logout
• HomePage (README content)
• Responsive Layout
• Settings page for toggling theme
• See Profile informations
  • Update username
  • User detail page
• Issues List page
  • Search & filter issues by author, label, assignee, closed/open, title, mentions, etc. (Inspiration: https://github.com/openstatusHQ/openstatus, https://docs.github.com/en/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)
• New issue page
  • Issue CRUD (by the author only)
  • Comments CRUD
  • Mentions
  • Issue Popovers (for previewing issues)
  • Linking between issues
  • Assign & self assign issues
• OpenGraph
  • landing (inspiration: https://github.com/trpc/trpc/blob/main/www/og-image/pages/api/landing.tsx)
  • Per Issue (inspiration: https://opengraph.githubassets.com/101e5bdeef8e959c800fab2aef88eef0b01b15d883e3e17c990bde8dfd67d6b3/trpc/trpc/issues/4306)
• Labels CRUD (can only add or update labels, no deleting)
• Notifications page
  • Notifications badge (Inspiration: https://gist.github.com/Fredkiss3/ab918aee3977d681f0508537a44838c0, https://github.com/Fredkiss3/bunrest)
  • Notifications for issues subscriptions
  • Notifications for mentions
  • Notifications for issue statuses
  • Filter notifications by status, title, closed, etc.
  • Mark as done, unsubscribe

Stack

• Next App Router
• drizzle + local Postgres database
• Hosted to a custom VPS, see the CI/CD workflow for how it is all deployed
• tailwindCSS for the styling

Requirements

• Node >= v16.6.2
• PNPM >= v6.22.2
• docker installed for local development
• A registered github app for authenticating users

🚀 How to work on the project ?

1. First you have to clone the repository

   git clone https://github.com/Fredkiss3/gh-next.git

2. Start the docker compose instance to start the DB + redis instance :

   docker-compose up -d --remove-orphans

3. Install the dependencies :

   pnpm install

4. Rename .env.example to .env.local And change the file to your needs,

5. And launch the project :

   pnpm run dev

   The app will show at http://localhost:3000.

6. Open the source code and start rocking ! 😎

🧐 Project structure

A quick look at the top-level files and directories you will see in this project.

  .
  ├── src/
  │    ├── app/
  │    │   ├── (actions)
  │    │   ├── (components)
  │    │   ├── (models)
  │    │   └── (routes)
  │    └──lib/
  │        ├── db/schema
  │        └── hooks
  ├── .prettierrc
  ├── pnpm-lock.yaml
  └── tsconfig.json

1. src/app/: this folder contains the source code to our app :

   1. (actions) : this folder contains all the logic of our app.

   2. (components) : this folder contains all the components of our app.

   3. (models) : this folder contains all the DB models of our app.

   4. (routes) : this folder contains all the routes & pages of our app.

2. src/lib/: this folder contains utils & helpers used throughout our app :

   1. db/schema : this folder contains all the drizzle sqlite schema for our DB.

   2. hooks : this folder contains all the react custom hooks used in the app.

3. .prettierrc: this file contains the configuration for prettier to enable autoformatting.

4. pnpm-lock.yaml: this file contains the dependencies lock for the repo.

5. tsconfig.json: this file contains the configuration for typescript, that are used by the all the underlying packages

🍳 ENV VARIABLES USED

Nom	role
SESSION_SECRET	random 32 chars length string used to encode the session id
REDIS_HTTP_URL	The URL to the connect to redis HTTP for a key/value store
DATABASE_URL	The URL to the connect to the Postres Database
REDIS_HTTP_USERNAME	LOCAL file server URL for storing key values
REDIS_HTTP_PASSWORD	LOCAL file server URL for storing key values
GITHUB_CLIENT_ID	github client id stored for our app used for authenticating users with github
GITHUB_PERSONAL_ACCESS_TOKEN	github client token stored for our app used for authenticating users with github
GITHUB_REDIRECT_URI	URL to redirect when a user has been authenticated
GITHUB_SECRET	github secret stored for our app