Skip to content

indunil-19/Smart-travel-guide-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧭 Smart Travel Guide App

A smart travel guide mobile application developed for Sri Lanka, featuring a mobile app, admin portal, and backend server.

🎥 Demo Video

Watch the demo of the Smart Travel Guide App:

Watch Demo


🗂️ Project Structure

The project has four main components:

  1. Backend Server

  2. Admin Portal

For a detailed user guide on using the admin portal, please refer to this document: Smart Travel Guide App - User Guide admin portal

  1. Mobile Application

For a detailed user guide on using the mobile application, please refer to this document: Smart Travel Guide App - User Guide mobile application

  1. Web Application

For a detailed user guide on using the web application, please refer to this document: Smart Travel Guide App - User Guide web application


🚀 Getting Started

🔁 Step 1: Clone the Repository

git clone https://github.com/indunil-19/Smart-travel-guide-app
cd Smart-travel-guide-app

🔧 Backend Server Setup

Backend Server Screenshot

📍 Location:

cd Server

🛠️ Installation:

npm install

▶️ Start the Server:

nodemon app     # If nodemon is installed
node app.js     # Otherwise

✅ You should see: app is working on port 5000


🖥️ Admin Portal and WebApplication Setup

📍 Location:

cd webapp

🛠️ Installation:

npm install

▶️ Run React App:

npm start

🌐 Open http://localhost:3000/ in your browser to access the landing page.

🌐 Open http://localhost:3000/travelPlan in your browser to access the travel plan web app.

🌐 Open http://localhost:3000/admin/signin in your browser to access the admin portal.


📱 Mobile App Setup

📍 Location:

cd Smart-travel-guide-app/smart_travel_guide

🛠️ Installation:

expo install
# or
npm install

🌐 Backend Integration (Using Ngrok)

You need ngrok to expose your local backend server to the internet:

🔌 Install ngrok:

npm install -g ngrok

🌍 Start ngrok:

ngrok http 5000

📸 Example output:\

🛠️ Configure API Endpoint

Copy the ngrok HTTPS forwarding URL and update the following file:

Smart-travel-guide-app/smart_travel_guide/src/config/config.js

Replace the localhost URL at line 2 with your ngrok URL.


▶️ Run the Mobile App

Start the Expo development server:

expo start

📱 You can now preview the mobile app on your Android/iOS device using Expo Go or an emulator.


📘 Resources


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages