gem-hunter
主要言語: TypeScript
Threads, Next.js 13 app that skyrocketed to 100 million sign-ups in less than 5 days, and dethroned giants like Twitter, ChatGPT, and TikTok to become the fastest-growing app ever! 🚀
Explore the live demonstration of the project: nextjs13-threads
Threads web application, a social media platform that allows users to share their thoughts, with their friends and family. Threads is a full-stack web application built with TypeScript using Next.js 13 with Server Side Rendering. It uses MongoDB as a database, and Clerk as an authentication provider. It also uses UploadThing to upload images to the cloud. The application is styled with Tailwind CSS and Shadcn components.
Folder Structurenextjs13-threads/ ├── app/ ├ ├── favicon.ico ├ ├── globals.css ├ ├── (auth)/ ├ ├ ├── onboarding/ ├ ├ ├ └── page.tsx ├ ├ ├── sign-in/[[...sign-in]]/ ├ ├ ├ └── page.tsx ├ ├ ├── sign-up/[[...sign-up]]/ ├ ├ ├ └── page.tsx ├ ├ └── layout.tsx ├ ├── (root)/ ├ ├ ├── layout.tsx ├ ├ ├── page.tsx ├ ├ ├── activity/ ├ ├ ├ └── page.tsx ├ ├ ├── communities/ ├ ├ ├ ├── [id]/ ├ ├ ├ ├ └── page.tsx ├ ├ ├ └── page.tsx ├ ├ ├── create-thread/ ├ ├ ├ └── page.tsx ├ ├ ├── edit-thread/[id]/ ├ ├ ├ └── page.tsx ├ ├ ├── explore/ ├ ├ ├ └── page.tsx ├ ├ ├── profile/ ├ ├ ├ ├── [id]/ ├ ├ ├ ├ └── page.tsx ├ ├ ├ └── edit/ ├ ├ ├ └── page.tsx ├ ├ ├── search/ ├ ├ ├ └── page.tsx ├ ├ └── thread/ ├ ├ ├── [id]/ ├ ├ ├ └── page.tsx ├ ├ └── reactions/[id]/ ├ ├ └── page.tsx ├ └── api/ ├ ├── uploadthing/ ├ ├ └── page.tsx ├ └── webhook/clerk/ ├ └── route.tsx ├── components/ ├ ├── atoms/ ├ ├ ├── CommunityCard.tsx ├ ├ ├── ThreadCard.tsx ├ ├ └── UserCard.tsx ├ ├── cards/ ├ ├ ├── EditThread.tsx ├ ├ ├── FollowUser.tsx ├ ├ └── ReactThread.tsx ├ ├── forms/ ├ ├ ├── AccountProfile.tsx ├ ├ ├── Comment.tsx ├ ├ ├── DeleteThread.tsx ├ ├ └── PostThread.tsx ├ ├── shared/ ├ ├ ├── Bottombar.tsx ├ ├ ├── Topbar.tsx ├ ├ ├── LeftSidebar.tsx ├ ├ ├── RightSidebar.tsx ├ ├ ├── Pagination.tsx ├ ├ ├── Searchbar.tsx ├ ├ ├── ProfileHeader.tsx ├ ├ └── ThreadsTab.tsx ├ └── ui/ (generated by shadcn/ui) ├ ├── button.tsx ├ ├── form.tsx ├ ├── input.tsx ├ ├── label.tsx ├ ├── tabs.tsx ├ └── textarea.tsx ├── constants/ ├ └── index.js ├── lib/ ├ ├── mongoose.ts ├ ├── uploadthing.ts ├ ├── utils.ts ├ ├── actions/ ├ ├ ├── community.actions.ts ├ ├ ├── thread.actions.ts ├ ├ └── user.actions.ts ├ ├── models/ ├ ├ ├── community.model.ts ├ ├ ├── thread.model.ts ├ ├ └── user.model.ts ├ └── validations/ ├ ├── thread.ts ├ └── user.ts ├── public/ ├ ├── next.svg ├ ├── vercel.svg ├ └── assets/ ├ └── [[...]].svg ├── components.json ├── middleware.ts ├── next.config.ts ├── package.json ├── postcss.config.js ├── tailwind.config.js ├── tailwind.config.js (meaningless) └── tsconfig.ts
(auth)/ - (root)/ - (api)/
In the app directory, nested folders are normally mapped to URL paths. However, you can mark a folder as a Route Group to prevent the folder from being included in the route's URL path.
This allows you to organize your route segments and project files into logical groups without affecting the URL path structure.
For example,
atoms/ - cards/ - forms/ - shared/ - ui/
The components directory contains all the components used in the application. The components are grouped into atoms, cards, forms, shared and ui.
the ui folder generated by shadcn/ui package and contains all the required shadcn components that used in the application.
index.js
This is a JavaScript code contains all the constants used in the application, specifically the Sidebar Navigation (sidebarLinks), Profile Tabs (profileTabs) and Community Tabs (communityTabs) constants.
actions/ - models/ - validations/ - mongoose.ts - uploadthing.ts - utils.ts
The lib folder holds crucial components for Threads App:
assets/ - next.svg - vercel.svg
The public directory contains the media used in the application. The assets folder contains all the images used in the application.
Table of ContentsTo get this project up and running in your development environment, follow these step-by-step instructions.
In order to install and run this project locally, you would need to have the following installed on your local machine.
Step 0:
Note ‼️ the application uses Clerk for Authentication and User Management, therefore, you need to create Clerk account here and sets the CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY environment variables in .env file. Also, the different URLs for the Clerk sign-in, sign-up, after sign-in and after sign-up pages.
Note ‼️ the application uses a MongoDB database, therefore, you need to create a database and connect it to the application, for this, change the MONGODB_URL environment variable in .env file located in server folder.
Note ‼️ the application uses a UploadThing Cloud, therefore, you need to create UploadThing account here and sets the UPLOADTHING_SECRET and UPLOADTHING_APP_ID environment variables in .env file.
After following all the instructions above, we'll want to create a new webhook on Clerk. To do this, go to the Clerk Dashboard, click on the "Webhooks" tab, and then click "Add Endpoint". For the Endpoint URL, enter http://<PASTE-YOUR-LINK-HERE>/api/webhook/clerk. For the evetnts, select the "organization", "organizationDomain", "organizationInvitation" and "organizationMembership". Then click "Create" to create the webhook. get the signing secret and set it as CLERK_WEBHOOK_SECRET environment variable in .env file.
Step 1:
Download or clone this repo by using the link below:
git clone https://github.com/ladunjexa/nextjs13-threads.git
Step 2:
Execute the following command in the root directory of the downloaded repo in order to install dependencies:
npm install
Step 3:
Execute the following command in order to run the development server locally:
npm run dev
Step 4:
Open http://localhost:3000 with your browser to see the result.
All scripts are defined in the package.json file. Here is a list of all scripts:
| Script | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:3000 |
npm run build |
Build your production site to ./dist/ |
npm run start |
Start your production site locally |
npm run lint |
Run ESLint |
Environment variables[^10] can be used for configuration. They must be set before running the app.
Environment variables are variables that are set in the operating system or shell, typically used to configure programs.
Threads uses Clerk, UploadThing, and MongoDB as external services. You need to create an account on each of these services and get the required credentials to run the app.
Create a .env file in the root directory of the project and add the following environment variables:
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=<CLERK_PUBLISHABLE_KEY> CLERK_SECRET_KEY=<CLERK_SECRET_KEY> NEXT_CLERK_WEBHOOK_SECRET=<CLERK_WEBHOOK_SECRET> NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/onboarding NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/ MONGODB_URL=<MONGODB_URL> UPLOADTHING_SECRET=<UPLOADTHING_SECRET> UPLOADTHING_APP_ID=<UPLOADTHING_APP_ID>
You can create an optimized production build with the following command:
npm run build
The easiest way to deploy this Next.js app is to use the Vercel Platform.
You can also deploy this Next.js app with Netlify.
Check out Next.js deployment documentation for more details.
Threads web application comes with the following features:
and much more...
In terms of technical features, Threads web application comes with the following features:
and much more..
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
To fix a bug or enhance an existing module, follow these steps:
git checkout -b improve-feature)git commit -am 'Improve feature')git push origin improve-feature)If you find a bug (failure of a module to execute its intended function), kindly open an issue here by including the issue with a title and clear description.
If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.
I'd like to express my gratitude to the following people who helped me with this project and made it possible:
Adrian Hajdin. (2023). Build and Deploy a Full Stack MERN Next.js 13 Threads App | React, Next JS, TypeScript, MongoDB. YouTube.
Threads is open source software licensed as MIT and is free to use — See LICENSE for more details.