Skip to content

woongsnote/next-sidebar

Repository files navigation

SideBar Template

This project is a template for creating a dashboard user interface using Next.js (with App Router), TypeScript, and shadcn/ui.

Features

  • Modern and responsive dashboard layout
  • Built with Next.js 14+ using the App Router for improved routing and layouts
  • TypeScript for type safety and improved developer experience
  • Utilizes shadcn/ui for beautiful and customizable UI components
  • Easy to extend and customize for your specific needs

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 16.8 or later)
  • npm or yarn

Getting Started

  1. Clone the repository:

    git clone https://github.com/woongsnote/next-sidebar.git
    
  2. Navigate to the project directory:

    cd next-sidebar
    
  3. Install dependencies:

    npm install
    
  4. Run the development server:

    npm run dev
  5. Open http://localhost:3000 in your browser to see the result.

Customization

  • Update the components in the components/ directory to match your design requirements
    • Update the navigation links in components/links.tsx
    • Update logo in components/logo.tsx
  • Modify or add new routes in the app/ directory
  • Adjust the global styles in app/globals.css
  • Update the tailwind.config.ts file to customize your Tailwind CSS setup

Deployment

This template can be easily deployed to platforms like Vercel or Netlify. Follow their respective documentation for deploying Next.js applications with App Router.

You can see the demo site in here

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments