Skip to content

Team-Goraebab/Goraebab-Frontend

Repository files navigation

🐳 Goraebab Frontend 🐳

Welcome to the Goraebab Frontend project!


πŸš€ Getting Started

βš™οΈ Prerequisites

  • Node.js - version v20.10.0 or higher
  • npm - for package management

πŸ“₯ Installation

  1. Clone the repository:

    git clone https://github.com/Team-Goraebab/Goraebab-Frontend.git
  2. Navigate to the project directory:

    cd Goraebab-frontend
  3. Install dependencies:

    npm install
  4. Start the development server:

    npm run dev

    The app will be available at http://localhost:3000.


πŸ›  Project Structure

Here's an overview of the key directories and files in the project:

goraebab-frontend/
β”œβ”€β”€ .github/                  # GitHub workflows and configurations
β”œβ”€β”€ .idea/                    # Project settings (for JetBrains IDEs)
β”œβ”€β”€ .next/                    # Next.js build output (auto-generated)
β”œβ”€β”€ node_modules/             # Project dependencies (auto-generated)
β”œβ”€β”€ public/                   # Static assets
β”œβ”€β”€ src/                      # Source files
β”‚   β”œβ”€β”€ app/                  # Main application logic
β”‚   β”‚   β”œβ”€β”€ dashboard/        # Dashboard components
β”‚   β”‚   β”œβ”€β”€ settings/         # Settings components
β”‚   β”‚   β”œβ”€β”€ api/              # API handlers
β”‚   β”‚   β”œβ”€β”€ favicon.ico       # Favicon file
β”‚   β”‚   β”œβ”€β”€ globals.css       # Global CSS
β”‚   β”‚   β”œβ”€β”€ layout.tsx        # Layout component
β”‚   β”‚   └── page.tsx          # Main page component
β”‚   β”œβ”€β”€ components/           # Reusable UI components
β”‚   β”œβ”€β”€ context/              # Context providers for global state
β”‚   β”œβ”€β”€ data/                 # Static or configuration data
β”‚   β”œβ”€β”€ hook/                 # Custom React hooks
β”‚   β”œβ”€β”€ services/             # API services and business logic
β”‚   β”œβ”€β”€ store/                # Zustand store configuration
β”‚   β”œβ”€β”€ types/                # TypeScript types and interfaces
β”‚   └── utils/                # Utility functions
β”œβ”€β”€ .env                      # Environment variables
β”œβ”€β”€ .eslintrc.json            # ESLint configuration
β”œβ”€β”€ .gitignore                # Git ignore rules
β”œβ”€β”€ .prettierrc               # Prettier configuration
β”œβ”€β”€ daemon.json               # Custom daemon configuration
β”œβ”€β”€ next-env.d.ts             # Next.js TypeScript environment definitions
β”œβ”€β”€ next.config.mjs           # Next.js configuration
β”œβ”€β”€ package.json              # Project metadata and dependencies
β”œβ”€β”€ package-lock.json         # Lockfile for npm dependencies
β”œβ”€β”€ postcss.config.mjs        # PostCSS configuration
β”œβ”€β”€ tailwind.config.ts        # Tailwind CSS configuration
β”œβ”€β”€ tsconfig.json             # TypeScript configuration
└── README.md                 # Project documentation

✨ Key Libraries

Here are some key libraries used in this project:

  • Next.js: A React framework for production-grade web applications with SSR (Server-Side Rendering).
  • React: The core UI library.
  • Zustand: A lightweight state management library, used for managing global state in the app.
  • axios: A promise-based HTTP client for making API requests.
  • Tailwind CSS: A utility-first CSS framework used for designing the UI.
  • MUI: A popular UI component library for React, used for implementing Material Design in the app.
  • Lucide: Icon library for adding vector icons to the app.
  • React-Draggable: A component used for making elements draggable within the UI.
  • Panzoom: Provides zoom and pan functionality for elements.
  • React Tooltip: A library to easily create tooltips in your app.
  • Notistack: Snackbar library for displaying notifications.
  • uuid: Generates unique IDs for various use cases.

πŸ“„ Available Scripts

  • dev: Run the development server.
  • build: Generate the production build.
  • start: Run the production server.
  • lint: Run ESLint to check for issues in the code.

πŸ“œ License

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

About

Goraebab 🐳 Frontend Repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages