doxart / MyVPN

Ready to use VPN app.
MIT License
3 stars 3 forks source link
android android-app android-application android-java android-studio android-vpn-app androidvpn app ivpn java java-vpn java-vpn-app javamobile mobile mobile-app openvpn openvpn-server vpn vpn-client

badge

My VPN

This project was made fast and without maps, so the code can be complex and unorganized. You can keep the main library and write your own using the same logic.

Welcome to my VPN application for Android, an open-source project that aims to provide a seamless and secure VPN experience on your Android device. This project was born out of the need for a reliable VPN solution with a focus on ease of use and privacy.

Features:

Why This Project?

Android lacks a comprehensive documentation or sample project for building a VPN application, and this project fills that gap. We believe that open-source development is the way to go, and we encourage contributions from the community to make this project even better.

We're excited to share this project with you and welcome your feedback, bug reports, and contributions. Feel free to dive into the code, contribute to the project, or simply use it for your private VPN needs.

Getting Started:

  1. Clone this repository.
  2. Build the project using Android Studio.
  3. Install the app on your Android device.
  4. Install firebase and setup app (Important).

Getting Started with Firebase Integration:

To enhance the capabilities of this VPN app, we have integrated Firebase, a comprehensive mobile and web application development platform, for analytics, crash reporting, and more. Here's how to set up Firebase for this project:

  1. Create a Firebase Project:

    • Visit the Firebase Console.
    • Click on "Add Project" and follow the on-screen instructions to create a new Firebase project.
  2. Add Your App to Firebase:

    • After creating the project, click on "Add app" to add your Android app to Firebase.
    • Follow the setup instructions and download the google-services.json file.
  3. Configure Firestore:

    • In the Firebase Console, navigate to the "Firestore Database" section.
    • Create a new Firestore database or use an existing one.
  4. Use Firestore in the Project:

    • This project uses Firestore to manage server configurations. You can find the code related to Firestore in this file. You need to create Firestore documents like that if you want to change it (collection id, document fields e.g..) you need to change codes inside of app.

      Document template

  5. Enable Remote Config:

    • In the Firebase Console, navigate to the "Remote Config" section.
    • Click on "Get Started" and follow the on-screen instructions to set up Remote Config for your project.
  6. Add Default Parameters:

    • To get started, upload this file to Remote Config.
  7. Add Google AdMob (Optional):

    • Create AdMob interstitial, rewarded and banner ads
    • Create Application class to app.

      public class MyApplication extends Application {
      @Override
      public void onCreate() {
      super.onCreate();
      
      MobileAds.initialize(this);
      }
      }
  8. Add Adapty Paywall SDK (Optional):

    • Create Adapty account and follow documentation about installing app.
    • Visit the Adapty.
    • Create Application class to app.

      public class MyApplication extends Application {
      @Override
      public void onCreate() {
      super.onCreate();
      
      MobileAds.initialize(this);
      Adapty.activate(this, "Insert your Adapty App Key", false);
      }
      }
    • And add app class in your AndroidManifest.xml.
      <application
        android:name=".MyApplication"
      </application>
  9. You're All Set!:

    • With Firebase integration, you can easily manage server configurations and other data for the VPN app.

Contributions:

We appreciate any contributions to this project, whether it's fixing a bug, improving the user interface, or adding new features.

License:

This project is open-source and licensed under the MIT License. Feel free to use, modify, and distribute it as per the license terms.

Contact:

If you have any questions or need assistance, please open an issue or reach out to us via email at gkdnzssmn@doxart.com.tr.

We hope you find this VPN application useful, and thank you for your support!