https://github.com/amirfakhrullah/gh-social
GitHub Social Platform built with Experimental Edge - Next.js App Router, Shadcn UI, tRPC, Clerk Auth, Drizzle Orm, Neon Serverless
https://github.com/amirfakhrullah/gh-social
clerk drizzle-orm edge neon nextjs pusher shadcn-ui trpc
Last synced: about 2 months ago
JSON representation
GitHub Social Platform built with Experimental Edge - Next.js App Router, Shadcn UI, tRPC, Clerk Auth, Drizzle Orm, Neon Serverless
- Host: GitHub
- URL: https://github.com/amirfakhrullah/gh-social
- Owner: amirfakhrullah
- License: mit
- Created: 2023-04-23T17:37:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T09:52:51.000Z (about 1 year ago)
- Last Synced: 2024-02-19T11:03:40.127Z (about 1 year ago)
- Topics: clerk, drizzle-orm, edge, neon, nextjs, pusher, shadcn-ui, trpc
- Language: TypeScript
- Homepage: https://gh.amrf.me
- Size: 334 KB
- Stars: 23
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Social
A social media platform for GitHub users built mostly with Experimental Edge stacks.
> **Warning**
> This project is using Next.js App Router, which is not production-ready yet. This project is built for learning/testing these stacks
## Demo
## Features
- You can follow/unfollow users, fork/star repositories and everything will sync-up with your GitHub account
- You can share repositories in a post to share/promote/discuss it with your GitHub followers
- Users can scroll through timeline in homepage to view the latest posts, trending posts and posts made by the users that you followed on GitHub
- Notifications feature - view notifications in real-time when someone starring your repositories, share it in a post, comment or like your posts
- User profile - you can view users profile, followers, following, posts, repositories, liked posts and comments
## Tech-stacks
- [Next.js App Router](https://beta.nextjs.org/docs)
- [Shadcn UI](https://ui.shadcn.com/)
- [tRPC](https://trpc.io/)
- [Clerk](https://clerk.com/)
- [Drizzle Orm](https://github.com/drizzle-team/drizzle-orm)
- [Neon Serverless](https://neon.tech/docs/serverless/serverless-driver#use-the-driver-over-http)
## Deployments/Hosting
- Next.js: [Vercel](https://vercel.com/)
- Database (PostgreSQL): [Neon](https://neon.tech/)
- Real-time Notifications: [Pusher](https://pusher.com/)
## Others
- [GitHub API](https://github.com/)
## Reference
I would like to shoutout [ploskovytskyy](https://github.com/ploskovytskyy) for open-sourcing his [edge project](https://github.com/ploskovytskyy/next-app-router-trpc-drizzle-planetscale-edge) which helped me a lot in configuring these edge stacks
## Getting Started
### Clone or fork the repository
To clone
```
git clone https://github.com/amirfakhrullah/gh-social.git
```
### Install
Copy `.env.example` to `.env` and update the credentials
```
cp .env.example .env
```
Install the dependencies (I'm using `pnpm`)
```
pnpm i
```
Run
```
pnpm dev
```
## License
License under the [MIT License](./LICENSE)