Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
doxart authored Dec 8, 2023
1 parent 1aebfb1 commit d8af55a
Showing 1 changed file with 4 additions and 33 deletions.
37 changes: 4 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,43 +40,20 @@ To enhance the capabilities of this VPN app, we have integrated Firebase, a comp
- In the Firebase Console, navigate to the "Firestore Database" section.
- Create a new Firestore database or use an existing one.

4. **Security Rules**:
- Configure security rules to ensure data privacy and security. Here's an example of basic rules:
```json
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: true;
}
}
}
```

5. **Use Firestore in the Project**:
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](https://github.com/doxart/MyVPN/blob/master/firestore-collection-template.json). 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](https://github.com/doxart/MyVPN/blob/master/firestore-document-template.png)

6. **Enable Remote Config**:
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.

7. **Add Default Parameters**:
6. **Add Default Parameters**:
- To get started, upload [this file](https://github.com/doxart/MyVPN/blob/master/remote_config_ivpn.json) to Remote Config.

8. **Add Google AdMob (Optional)**:
7. **Add Google AdMob (Optional)**:
- Create AdMob interstitial, rewarded and banner ads
- Enter the ad IDs in the field specified [strings.xml](https://github.com/doxart/MyVPN/blob/master/app/src/main/res/values/strings.xml) file.
```xml
<resources
<string name="admob_id" translatable="false">Insert your Admob App ID</string>

<string name="banner_id">Insert your banner Ad ID</string>
<string name="rewarded_id">Insert your rewarded Ad ID</string>
<string name="interstitial_id">Insert your interstitial Ad ID</string>
</resources>
```
- Create Application class to app.
```java
public class MyApplication extends Application {
Expand Down Expand Up @@ -110,12 +87,6 @@ To enhance the capabilities of this VPN app, we have integrated Firebase, a comp
android:name=".MyApplication"
</application>
```
- Enter the placement ID in the field specified [strings.xml](https://github.com/doxart/MyVPN/blob/master/app/src/main/res/values/strings.xml) file.
```xml
<resources
<string name="adapty_placement_id">Insert your Adapty Placement ID</string>
</resources>
```

11. **You're All Set!**:
- With Firebase integration, you can easily manage server configurations and other data for the VPN app.
Expand Down

0 comments on commit d8af55a

Please sign in to comment.