Travelly: Explore, Dream, Book 🌍

Travelly is a travel application designed to inspire exploration, simplify trip planning, and make booking effortless. Built with modern web technologies, Travelly is your go-to platform for all things travel.

🚀 Features

• Inspiration: Discover new destinations and travel ideas
• Trip Planning: Easily plan and organize your trips
• Effortless Booking: Streamlined booking process for flights, hotels, and activities

🛠️ Tech Stack

• ✨ Frontend: Next.js
• 🌍 Deployment: Vercel
• 🎨 Styling: Tailwind CSS
• 🚀 Monorepo: Turborepo
• 🌱 Database: MongoDB
• 👨‍🎨 UI Development: Storybook (Vite)
• 🍵 Documentation: Mintlify
• 🔒 Authentication: Clerk

🏗️ Project Structure

Travelly is a monorepo managed with Turborepo, consisting of three main applications: Web, Storybook, Docs

.
├── apps/
│   ├── docs/          # Documentation (Mintlify)
│   ├── storybook/     # UI Component development
│   └── web/           # Main Next.js application
├── packages/
│   ├── config/        # Shared configurations
│   ├── design-system/ # UI component library
│   └── utils/         # Shared utilities
└── tooling/           # Development tools

📚 Available Scripts

• pnpm run dev: Start all apps in development mode
• pnpm run build: Build all apps and packages
• pnpm run typecheck: Run typechecking across the entire monorepo
• pnpm run format: Format all files using Prettier
• pnpm run lint: Lint all files using Eslint
• pnpm run check-dependencies: Check for dependency issues using Sherif
• pnpm run clean: Clean up all build artifacts and caches

🚦 Getting Started

Prerequisites

• Node.js (22 or later)
• pnpm
• mintlify

Installation

1. Clone the repository:

   git clone [email protected]:nass59/nextjs-travel.git
   cd nextjs-travel

2. Install dependencies:

   pnpm install

3. Set up environment variables:

   cd apps/web
   cp .env.example .env.local

   Edit the .env.local file with your specific configuration.

Development

To run the development server:

pnpm run dev

This will start the Next.js app, Storybook, and the documentation site concurrently.

Building for Production

To build all apps and packages:

pnpm run build

📖 Documentation

To run the documentation:

cd apps/docs
pnpm run dev

📝 License

Travelly is licensed under the MIT License.

🙏 Acknowledgements

• Next.js
• Tailwind CSS
• Vercel
• Turborepo
• Storybook
• Mintlify
• Clerk

---

Built with ❤️ by the Travelly Team