README.md

Learn Git

Learn Git is a free and open-source platform to learn Git. It is designed to be simple and easy to understand for beginners.

⭐ Features

🐭 Frameworks

• Next.js - The React Framework for the Web (with App Directory)

🐮 Platforms

• Vercel – Deploy your Next.js app with ease

🐒 UI

• Tailwind CSS – Utility-first CSS framework for rapid UI development
• Shadcn/ui – Re-usable components built using Radix UI and Tailwind CSS
• next/font – Optimize custom fonts and remove external network requests for improved performance
• MDX – Markdown for the components

🐴 Code Quality

• TypeScript – Static type checker for end-to-end type safety
• Prettier – Opinionated code formatted for consistent code style
• ESLint – Pluggable linter for Next.js and TypeScript

🐑 Performance

• Vercel Analytics – Real-time performance metrics for your Next.js app

📦 Apps and Packages

• web: The main Next.js application
• UI: Shared UI components

🏛 Architecture

Learn more about the project's architecture in the architecture document.

🚀 Getting Started

Installation

1. Clone the repository:

   git clone https://github.com/nicholasadamou/learn-git.git
   cd learn-git

2. Install dependencies:

   npm install
   # or
   yarn install
   # or
   pnpm install
   # or
   bun install

3. Create a .env.local file in the root directory and add the following environment variables:

   GITHUB_TOKEN=<YOUR_GITHUB_TOKEN>

   This is used to get the latest commit for this project from the GitHub API to be used in the footer.

Development

Running the Development Server

Start the development server with the following command:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 in your browser to view the application.

You can start editing the page by modifying app/page.tsx. The page will auto-update 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, check out the following resources:

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

You can also visit the Next.js GitHub repository for more information and to contribute feedback or code.

📜 License

This project is licensed under the MIT License. For more information, see the LICENSE file.

You can check out the Next.js GitHub repository.