Overview

WebNav is a front-end navigation website designed to curate high-quality front-end resources from various sources, both domestic and foreign. Users can easily save and access these websites for personal use. Additionally, the platform allows users to capture webpage information with a single click to create shareable cards. The project is inspired by Taxonomy and aims to serve as a learning experience in building a modern app using Next.js 13, incorporating features like authentication, API routes, static pages for documentation, ORM, and more.

Features

• New /app directory: Separation of server and client components.
• UI Components using Radix UI: Utilizes UI Components built with Radix UI.
• Styled with Tailwind CSS: Custom styling using Tailwind CSS.
• Dark mode with next-themes: Supports a dark mode option utilizing next-themes.
• Authentication with NextAuth.js: Implements authentication using NextAuth.js.
• ORM with Prisma: Object-Relational Mapping with Prisma for database interactions.
• MySQL Database on PlanetScale: Uses a MySQL Database hosted on PlanetScale.
• Written in TypeScript: Codebase is written in TypeScript for type safety.

Installation

1. Clone the repository and navigate to the project directory.
2. Install dependencies using pnpm install.
3. Copy the .env.example file to .env, and update the necessary variables.
4. Sync the database table and add initial data.
5. Start the development server by running pnpm dev.

Summary

WebNav is a feature-rich front-end navigation website built with Next.js 13, offering a modern user experience with various functionalities such as authentication, ORM integration, and dark mode support. With its clean UI components, tailored styling with Tailwind CSS, and TypeScript implementation for type safety, WebNav provides a robust platform for curating and accessing front-end resources conveniently.