mihirdomadiya / trip-amaze

Trip Amaze

Trip Amaze is a comprehensive trip management system designed to help users plan and manage their trips efficiently. The project features a modern web application with a React.js frontend and a Node.js backend, utilizing MongoDB for database management.

Table of Contents

• Features
• Technologies
• Project Structure
• Installation
• Usage
• Contributing
• License

Features

• User Authentication: Secure user login and registration.
• Trip Management: Create, edit, and manage trips.
• Destination Information: Add and view details about travel destinations.
• Real-Time Updates: Stay updated with real-time notifications and trip changes.
• Responsive Design: Access the application on various devices seamlessly.

Technologies

• Frontend: React.js
• Backend: Node.js with Express.js
• Database: MongoDB
• Authentication: JWT (JSON Web Tokens)
• Deployment: Heroku / Vercel (example)

Project Structure

The project is organized into two main folders:

• frontend/: Contains the React.js frontend application.

  • src/: Source code for the frontend.
  • public/: Public assets and index.html.
  • package.json: Frontend dependencies and scripts.

• backend/: Contains the Node.js backend application.

  • src/: Source code for the backend.
  • config/: Configuration files.
  • models/: MongoDB models.
  • routes/: API routes.
  • package.json: Backend dependencies and scripts.

Installation

To get started with Trip Amaze, follow these steps:

Prerequisites

• Node.js (version 14 or higher)
• npm or yarn

Backend Setup

1. Navigate to the backend directory:

   cd backend
   npm install
   npm start
   

Backend Setup

2. Navigate to the frontend directory:

   cd frontend
   npm install
   npm start
   
   

Adjust the GitHub Profile link if you have a different URL or additional contact information.