GitHub Homepage template built with Next.js, TypeScript and TailwindCSS.

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Folder Structure
  • Tech Stack
• Getting Started
  • Installation
  • Run Locally
• Screenshots
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

Next.js has the potential to revolutionize the industry and forever change the way we develop web applications. You’re still early in catching the trend and building your own Next.js 13 applications with TypeScript that leverage features such as server-side rendering and the app router.

This repository houses an amazing Frontend Next.js 13 Application which simulates the homepage of GitHub using Next.js, TypeScript, and TailwindCSS, combining powerful tools to deliver a responsive and user-friendly experience.

‼️ Folder Structure

Here is the code folder structure.

src/
├── @types/
│   └── index.ts
├── app/
│   ├── favicon.ico
│   ├── globals.css
│   ├── layout.tsx
│   └── page.tsx
├── assets/
│   └── icons/
|       └── ...
├── components/
│   ├── atoms/
│   │   ├── AnimatedAnchor.tsx
│   │   ├── AnimatedUnderline.tsx
│   │   ├── AtomsSec.tsx
│   │   ├── BranchPicture.tsx
│   │   ├── CopilotBlock.tsx
│   │   ├── HTMLBlock.tsx
│   │   ├── Picture.tsx
│   │   └── index.ts
│   ├── layout/
│   │   ├── navbar/
|   |   |   ├── options/
|   |   |   |   ├── OpenSource.tsx
|   |   |   |   ├── Product.tsx
|   |   |   |   └── Solutions.tsx
|   |   |   ├── utils/
|   |   |   |   ├── NavListItem.tsx
|   |   |   |   └── StickyNavbar.ts
|   |   |   └── index.tsx
│   │   ├── footer/
|   |   |   └── index.tsx
|   |   └── index.ts
│   ├── sections/
│   │   ├── Hero.tsx
│   │   ├── Productivity.tsx
│   │   ├── Collaboration.tsx
│   │   ├── Security.tsx
│   │   └── index.ts
│   └── widgets/
│       ├── BranchProd.tsx
│       ├── BranchCollab.tsx
│       ├── BranchSec.tsx
│       ├── CollabDialog.tsx
│       ├── Copilot.tsx
│       ├── Earth.tsx
│       ├── Globe.tsx
│       ├── IDE.tsx
│       ├── InteractiveCard.tsx
│       └── index.ts
├── data/
|   └── index.js
├── lib/
|   ├── hooks/
|   |   ├── useFloat.tsx
|   |   └── useNav.tsx
|   ├── GenerateContainer.tsx
│   └── index.ts
├── .eslintrc.json
├── .gitignore
├── next-env.d.ts
├── next.config.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── tsconfig.json

👾 Tech Stack

(back to top)

🧰 Getting Started

⚙️ Installation

Step 1:

Download or clone this repo by using the command below:

 https://github.com/ladunjexa/GitHub-Webpage.git

Step 2:

This webapp using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

In root folder execute the following command to get the required packages:

  npm install

🏃 Run Locally

Step 1:

Go to root folder and execute the following command in order to run the webapp:

  npm run dev

(back to top)

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

(back to top)

📷 Screenshots

(back to top)

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

⚠️ License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/GitHub-Webpage

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in Flexibble Web project.

• NextJS
• React
• TypeScript
• TailwindCSS
• UUID
• Cobe
• React Spring
• Framer Motion

(back to top)