https://github.com/edamghy/topbrico-next
https://github.com/edamghy/topbrico-next
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/edamghy/topbrico-next
- Owner: EDAMGHY
- Created: 2024-12-01T21:43:06.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-01-19T20:05:18.000Z (4 months ago)
- Last Synced: 2025-02-05T13:38:21.967Z (4 months ago)
- Language: TypeScript
- Size: 260 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TopBrico NextJS
## Overview
This is a starter template for building applications with Next.js. It includes a basic setup with TypeScript, Tailwind CSS, and Docker support.
## Features
- **Next.js**: The React framework for production.
- **TypeScript**: Typed JavaScript at Any Scale.
- **Tailwind CSS**: A utility-first CSS framework for rapid UI development.
- **Docker**: Containerization for consistent development and deployment environments.
## Getting Started
### Prerequisites
- Node.js (>= 20)
- Docker (optional, for containerization and deploy)
### Installation
1. Clone the repository:
```bash
git clone
cd
```
2. Install dependencies:
```bash
yarn install
```
3. Copy the example environment variables file and configure it:
```bash
cp .env.example .env
```
### Running the Development Server
To start the development server, run:
```bash
yarn dev
```
## Folder Structure
The starter template includes the following folders:
- **@/ui**: Contains UI elements powered by [shadcn](https://ui.shadcn.com).
- **@/theme**: Houses all theme-related setup, including dark mode and multi-theme configurations.
- **@/layout**: Contains layout-related components and configurations.
- **@/types**: Stores interfaces and types to ensure type safety.
- **@/lib**: Includes utility functions and helpers used throughout the project.