{"id":19869657,"url":"https://github.com/omkargade04/globeguide","last_synced_at":"2026-01-25T13:32:27.384Z","repository":{"id":255258092,"uuid":"849024529","full_name":"omkargade04/GlobeGuide","owner":"omkargade04","description":"This is a web application that generates personalized travel itineraries based on user preferences, such as budget, interests, and trip duration. The application offers a user-friendly interface for inputting preferences and deliver detailed, dynamic itineraries tailored to individual users.","archived":false,"fork":false,"pushed_at":"2024-10-10T11:51:01.000Z","size":3809,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-12T16:02:52.271Z","etag":null,"topics":["docker","expressjs","gemini-api","google-maps-api","mongodb","nextjs","nodejs","oop","redis"],"latest_commit_sha":null,"homepage":"https://personalized-itinerary-generator.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/omkargade04.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-28T20:52:18.000Z","updated_at":"2024-11-02T16:41:52.000Z","dependencies_parsed_at":"2024-08-28T22:26:38.395Z","dependency_job_id":"7a4de73e-b241-4cd6-be9e-abb2978ad595","html_url":"https://github.com/omkargade04/GlobeGuide","commit_stats":{"total_commits":39,"total_committers":2,"mean_commits":19.5,"dds":"0.10256410256410253","last_synced_commit":"167cb6ce40a9599d9c410af405cf681113385030"},"previous_names":["omkargade04/personalized-itinerary-generator","omkargade04/globeguide"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omkargade04%2FGlobeGuide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omkargade04%2FGlobeGuide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omkargade04%2FGlobeGuide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omkargade04%2FGlobeGuide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omkargade04","download_url":"https://codeload.github.com/omkargade04/GlobeGuide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224305847,"owners_count":17289446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","expressjs","gemini-api","google-maps-api","mongodb","nextjs","nodejs","oop","redis"],"created_at":"2024-11-12T16:04:47.702Z","updated_at":"2026-01-25T13:32:27.355Z","avatar_url":"https://github.com/omkargade04.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Personalised Travel Itinerary Generator\n\nThis is a web application that generates personalized travel itineraries based on user preferences, such as budget, interests, and trip duration. The application offers a user-friendly interface for inputting preferences and deliver detailed, dynamic itineraries tailored to individual users.\n\n## Table of Contents\n\n1. [Project Overview](#project-overview)\n2. [Features](#features)\n3. [Technologies and Libraries Used](#technologies-and-libraries-used)\n4. [Installation](#installation)\n5. [Models Used](#models-used)\n\n## Project Overview\n\nThis application provides a web interface for creating your prefered itinerary for their desired destination. It has a user friendly form to fill for preferences such as destination, duration, budget and travelers. And using this information we create a personalized itinerary for the user. Leveraged Gemini's API to generate personalized travel itinerary for the user.\n\n## Features\n\n- User Authentication.\n- User friendly interface.\n- Leveraged Gemini's API to generate personalized travel itinerary for the user\n- User can view their detailed itinerary.\n- User can view their created trip too.\n- User receives the entire itinerary in PDF form via mail\n\n## Technologies and Libraries Used\n\n- **Backend**:\n\n  - Typescript: Implemented MVC structure in OOP fashion and ensured type safety of the data using typescript.\n  - Node.js: Used to setup the environment for backend.\n  - Express.js: Built scalable backend server.\n  - Mongo DB: Stored the user info and itinerary details using mongo database.\n  - Redis: Used redis for rate limiting of creating trips.\n  - Puppeteer: Used to convert the generated Itinerary to PDF format.\n  - Nodemailer: Used to mail the itinerary in PDF form to the user's email.\n  - Docker: Leveraged docker to containerize the application.\n  - Continuous Integration(CI): Impleneted Continuous Integration pipeline for lint check and healthy build for pull request at main branch.\n\n- **Frontend**:\n\n  - Typescript: Ensured type safety of the data using typescript and enhances development efficiency, code quality, and maintainability.\n  - Next.js: Built the entire client side and integrating backend apis using Next.js.\n  - Tailwind CSS: Used tailwind css for responsive interface for across all devices.\n  - Shadcn UI: Leveraged Shadcn UI library for building user friendly UI components.\n  - Docker: Leveraged docker to containerize the application.\n  - Continuous Integration(CI): Impleneted Continuous Integration pipeline for lint check and healthy build for pull request at main branch.\n\n- **Models**:\n  - Gemini AI Model for generating user personalized itinerary.\n  - Google Maps API for directing to specific destination location.\n\n\n## View website\n\nHere is the deployed website : [Deployed Link](https://personalized-itinerary-generator.vercel.app/)\u003cbr\u003e\nHere is the deployed backend server: [Backend Link](https://personalized-itinerary-generator.onrender.com/)\n\n## Installation\n\nTo install and run this project locally, add the following commands in your terminal, follow these steps:\n\n1. Clone the repository from GitHub:\n\n```bash\n    git clone https://github.com/omkargade04/Personalized-Itinerary-Generator.git\n```\n\n2. Navigate into the project directory:\n\n```bash\n   cd Personalized-Itinerary-Generator\n```\n\n3. Navigate into client:\n\n```bash\n   cd frontend\n```\n\n4. Navigate into server:\n\n```bash\n   cd backend\n```\n\n## Important\n\n5. Ensure that the version of `Node.js` and `npm` you're using is compatible with the dependencies you're installing. Some dependencies may require specific Node.js versions.\n   Run the below command in **frontend** directory and **backend** directory.\n\n```bash\n   npm install -g npm@latest\n```\n\n6. Install `dependencies` for the frontend in **frontend** directory (assuming you have `Node.js` and `npm` installed):\n\n```bash\n   npm install\n```\n\n7. Install `dependencies` for the backend in **backend** directory (assuming you have `Node.js` and `npm` installed):\n\n```bash\n   npm install\n```\n\n8. Create a .env file in the **frontend** directory and add backend **api endpoint**:\n\n`NEXT_PUBLIC_BASE_URL`=`http://localhost:8000` (for **local** backend)\n\n`NEXT_PUBLIC_BASE_URL`=`https://personalized-itinerary-generator.onrender.com` (for **deployed** backend)\n\n`NEXT_PUBLIC_GOOGLE_PLACE_API_KEY`=`google-place-api-key`\n\n`NEXT_PUBLIC_GEMINI_API_KEY`=`gemini-api-key`\n\n9. Create a .env file in the **backend** directory and connect your database with prisma via database url:\n\n`PORT`=`8000` \u003cbr\u003e\n\n`MONGO_URL`=`mongodb+srv://\u003cusername\u003e:\u003cpassword\u003e@cluster0.dvriq5l.mongodb.net/\u003cdb_name\u003e` \u003cbr\u003e\n\n`SECRET_TOKEN`=`your-token` \u003cbr\u003e\n\n`REDIS_URL`=`https://casual-pig-60980.upstash.io:6379` \u003cbr\u003e\n\n`REDIS_TOKEN`=`upstash-redis-token` \u003cbr\u003e\n\n`NODE_ENV`=`development` \u003cbr\u003e\n\n`MAIL_USERNAME`=`your-email@gmail.com` \u003cbr\u003e\n\n`MAIL_PASSWORD`=`your-password` \u003cbr\u003e\n\n`GOOGLE_PLACE_API_KEY`=`your-google-place-api-key` \u003cbr\u003e\n\n10. Start the frontend and backend servers:\n\n    **backend**: `npm run dev`\u003cbr\u003e\n    **frontend**: `npm run dev`\n\n11. Open `http://localhost:3000` to view the application.\n\n## Run the project via **Docker**\n\n## Prerequisites\n\n- Docker\n\n## For Linux System:\n\nTo install Docker, run the following commands in your terminal:\n\n```bash\ncurl -fsSL https://get.docker.com -o get-docker.sh\nsudo sh get-docker.sh\n```\n\n## Development Environment For Server\n\n- Navigate into **backend** directory\n- To get started with development first build the dev containers using the following command\n\n```bash\ndocker-compose -f docker-compose.yaml build\n```\n\n- The env file being used for development is called `.env`\n- Run the containers using the command\n\n```bash\ndocker-compose -f docker-compose.yaml up\n```\n\n## Development Environment For Client\n\n- Navigate into **frontend** directory\n- To get started with development first build the dev containers using the following command\n\n```bash\ndocker-compose -f docker-compose.yaml build\n```\n\n- The env file being used for development is called `.env`\n- Run the containers using the command\n\n```bash\ndocker-compose -f docker-compose.yaml up\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomkargade04%2Fglobeguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomkargade04%2Fglobeguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomkargade04%2Fglobeguide/lists"}