/travel-safe

Primary LanguageDartApache License 2.0Apache-2.0

Travel Safe

Being Concerned with the increasing brutality and insecurities faced by women during their travel, Despite of many Safety apps, none of them properly solves this problem.
Travel Safe- A Flutter Application will help in preventing such instances and will promote safe and secure travel.
If you think that your notable tech skills can help women of our country travel safely, Please be a part of Travel Safe and join our mission to make the world a safer place.


Getting Started

This project is in the early stage of development. So anyone who is willing to Contribute can have a look at it . If you face any issue or confusion while contributing , we will be happy to help you with it.

How to Use

Step 1:

Download or clone this repo by using the link below:

https://github.com/codingindia/travel-safe.git

Step 2:

Go to project root and execute the following command in console to get the required dependencies:

flutter pub get 

Step 3:

You may find Folder master , it contains main codebase for the project. Go to themaster folder and run the following command.

flutter run

You will be able to run the project Successfully with the help of these steps.

Features

  • Share live location with a friend or in a group.
  • Panic Button to send the alarm to all the people with whom locations is being shared
  • Stop my Location Feature

Technologies Used

Flutter is Google's SDK for crafting beautiful, fast user experiences for mobile, web and desktop from a single codebase. Flutter works with existing code, is used by developers and organizations around the world, and is free and open source.

Installation


Folder Structure

Here is the core folder structure which flutter provides.

flutter-app/
|- android
|- assets/images
|- ios
|- lib
|- test

Here is the folder structure we have been using in this project

lib/
|- screens/
|- main.dart

Now, lets dive into the lib folder which has the main code for the application.

1- screens - This Contains all the screens which will be available in the App.
2- main.dart - This is the starting point of the application. All the application level configurations are defined in this file i.e, theme, routes, title, orientation etc.

screens

This directory contains all the application level screens. A separate file is created for each screen.

screen/
|- introPage.dart
|- login.dart
|- maps.dart
|- register.dart
|- shared_location.dart

ScreenShots

How to Contribute

This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests by submitting pull requests as well.This project adheres to the Contributor Covenant. By participating, you are expected to uphold this code style. Please report issues here https://github.com/codingindia/travel-safe. While opening a new pull request or a new issue please adhere to the pull request template, bug report template and feature request template.

Branch Policy

We have the following branches

  • development All development goes on in this branch. If you're making a contribution, you are supposed to make a pull request to development.

    It is advisable to clone only the development branch using the following command:

    git clone -b <branch> <remote_repo>

    Example:

    git clone -b my-branch git@github.com:user/myproject.git

    Alternative (no public key setup needed):

    git clone -b my-branch https://git@github.com/username/myproject.git

    With Git 1.7.10 and later, add --single-branch to prevent fetching of all branches. Example, with development branch:

    git clone -b development --single-branch https://github.com/username/travel-safe

  • master This contains the stable code. After significant features/bugfixes are accumulated on development, we move it to master.

  • Code Of Conduct


Conclusion

We will be happy to answer your queries that you may have on this approach, and if you want to lend a hand with the travel safe then please feel free to submit an issue and/or pull request 🙂

If you liked this project, don’t forget to ⭐ star the repo to show your support.