Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/om-jannu/packurbag
https://github.com/om-jannu/packurbag
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/om-jannu/packurbag
- Owner: Om-jannu
- Created: 2023-10-07T21:51:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T16:53:26.000Z (9 months ago)
- Last Synced: 2024-04-11T09:59:16.869Z (9 months ago)
- Language: Dart
- Size: 10.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tour Buddy
Tour Buddy is a travel support app designed to enhance your travel experience with various features including category-based to-do task lists, currency converter, calculator, language translation, and emergency SOS.
## Features
- **Category-based To-Do Task List**: Organize your tasks by categories such as sightseeing, dining, accommodation, etc., to stay organized during your travels.
- **Currency Converter**: Easily convert currencies to help you manage your expenses and budget effectively in different countries.
- **Calculator**: Perform quick calculations while on the go, whether it's budgeting or splitting bills with friends.
- **Language Translation**: Overcome language barriers with built-in translation features, helping you communicate effectively in foreign countries.
- **Emergency SOS**: Access emergency assistance quickly with the SOS feature, providing peace of mind during your travels.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/Om-jannu/packurbag.git
```
2. Navigate into the project directory:
```bash
cd packurbag
```
3. Install dependencies for flutter:
```bash
flutter pub get
```
4. Install dependencies for server:
```bash
cd server
```
```bash
npm install
```
## Usage
### Server Setup (Step 1.):
1. Create `.env` file inside the server diretory and add :
(**Note: use appropriate mongo url**)
```
MONGO_URL="mongodb+srv://:@beyondthebasics.abcde.mongodb.net/test"
PORT=5000
```
1. Run server:
```bash
npm run dev
```
Here's a guide for setting up Ngrok and starting port forwarding:
### Ngrok Setup & Installation (Step 2):
1. **Download Ngrok**:
- Go to the [Ngrok website](https://ngrok.com/) and sign up for an account if you haven't already.
- Download the Ngrok executable suitable for your operating system.
2. **Start Port Forwarding**:
- Open a terminal or command prompt window.
- To start port forwarding, run the following command:
```
ngrok http 5000
```
This command starts forwarding traffic from Ngrok's randomly generated public URL to your local server running on port 5000.
3. **Copy the public URL**.
`Note: if ngrok command doesn't work on cmd prompt, try running with admin privileges or sudo privileges`
### Flutter Setup (Step 3.):
1. Choose an android emulator
2. Change **serverIp** in `lib/main.dart` file
```
const serverIp = "";
example : https://cb4f-103-xxx-xxx-122.ngrok-free.app;
```
3. Run Command
```
flutter pub get
flutter run
```
## Screenshots
##### 1. QuickActions, Login & Register
##### 2. Home & AddTodo
##### 3. Category, Todolist & Translation
##### 4. Bluetooth Screens
##### 5. Calculator, Currency Converter & Profile
##### 6. Emergency SOS Page
## Contributing
If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature`)
3. Make your changes
4. Commit your changes (`git commit -am 'Add new feature'`)
5. Push to the branch (`git push origin feature`)
6. Create a new Pull Request.