languageXchange | Practice, Learn, Succeed!

languageXchange is an application built with Angular and Ionic that helps users exchange different languages by connecting them with native speakers. Users can join chat rooms with other participants and practice their language skills in a fun and interactive way. The app is available on web, iOS, and Android platforms. It uses @appwrite for the back-end. For a detailed list of technologies used, please refer to the Tech Stack section.

Table of Contents

• Project Overview
• Status
• Tech Stack
• Links
• Installation
  • Cloud Functions
• Usage
• Deep Linking
  • Android Deep Linking
  • iOS Universal Links
• Firebase Messaging Service Worker
• Contributing
• Security
  • Paths
  • Google Services
• Stats
  • Stargazers
  • Contributors
• License

Status

This project is currently in Beta phase v0.7.x For more information, please refer to the project's GitHub repository.

To check the status of the website, database and CDN, and all clients which are iOS, Android, and Web App. please visit the following link: https://status.languagexchange.net/

Tech Stack

• Language: TypeScript
• Landing Page: Svelte
• Framework: Ionic Angular
• Native: Capacitor
• Database: Appwrite
• API: Expressjs, Nodejs
• Cloud Functions: Appwrite
• Push Notification: Firebase Cloud Messaging
• Storage: DigitalOcean Spaces
• Analytics: Google Analytics

Links

• App Landing Page
• iOS App
• Android App
• Web App

Installation

To install the project locally, follow these steps:

1. Clone the repository to your local machine using the command git clone https://github.com/newchaptertech/languageXchange.git
   • Navigate to the project directory using the command cd languageXchange
   • Install the Ionic CLI globally using the command npm install -g @ionic/cli
   • Install the project dependencies using the command npm install
2. Create a new Appwrite project and enable the Authentication and Database services.
   • In the Appwrite console, go to Project Settings and copy the Appwrite endpoint and project ID.
   • Rename the environment.ts.sample file in the src/environments directory to environment.ts
   • Rename the environment.prod.ts.sample file in the src/environments directory to environment.prod.ts
   • Replace the placeholders in the environment.ts.sample file with your actual values. For example, replace <API_URL> with the actual URL of your API, <DB_URL> with your database URL, and so on. Make sure to replace all placeholders in the file.
3. Start the development server using the command ionic serve
4. Open your web browser and navigate to http://localhost:8100

That's it! You should now be able to see the project running locally on your machine. If you encounter any issues during the installation process, please refer to the project's documentation or open an issue on the projects GitHub repository.

Cloud Functions

To push Appwrite Cloud Functions, follow these steps:

1. Make sure you have the Appwrite CLI installed on your machine. If you don't have it installed, you can install it using the command npm install -g appwrite
2. Navigate to the root directory of your Appwrite project using the command line.
3. Run the command appwrite login to log in to your Appwrite account.
4. Run the command appwrite functions create to initialize the Appwrite Cloud Functions in your project.
5. Follow the prompts to select your Appwrite project and choose the language you want to use for your functions.
6. Once the initialization is complete, you can check Cloud Functions code in the appwrite/functions/index.js file (if you're using JavaScript) or you can convert appwrite/functions/index.js to appwrite/functions/index.ts file (if you're using TypeScript).
7. Once you've written your Cloud Functions code, run the command appwrite functions deploy to deploy your functions to Appwrite.
8. Go to database function console and make sure that right permissions you set for related function.

That's it! You should now be able to push your Appwrite Cloud Functions to Appwrite and use them in your app. If you encounter any issues during the process, please refer to the Appwrite documentation or open an issue on the Appwrite GitHub repository.

Usage

To use the project, follow these steps:

1. Open your web browser and navigate to the URL where the project is hosted.
2. If you haven't already done so, create an account and log in to the app.
3. Once you're logged in, you'll be taken to the home page where you can see a list of available language exchange sessions.
4. To join a chat room, click on the user you're interested in to open private chat page.
5. Once you've joined a chat room, you'll be able to chat with other participants and practice your language skills.

That's it! You should now be able to use the project to practice your language skills with other users. If you encounter any issues during the usage process, please refer to the project's documentation or open an issue on the project's GitHub repository.

Deep Linking

Deep linking is a technique that allows an app to be opened to a specific UI or state, using a URL. This is useful for a variety of reasons, such as driving user engagement from web to app, or simply providing a better user experience.

Android Deep Linking

1. Create a /src/.well-known directory in your project's src directory.

2. Inside the /src/.well-known directory, create a file named assetlinks.json

3. In the assestslinks.json file, add the following code to it:

[
  {
    "relation": ["delegate_permission/common.handle_all_urls"],
    "target": {
      "namespace": "android_app",
      "package_name": "com.example.yourapp",
      "sha256_cert_fingerprints": ["14:6D:E9:..."]
    }
  }
]

Replace com.example.yourapp with your app's package name and replace 14:6D:E9:... with the SHA-256 fingerprint of your app's signing certificate.

4. Add the /src/.well-known directory to the assets array in your angular.json file.

"assets": [
  "src/favicon.ico",
  "src/assets",
  {
    "glob": "**/*",
    "input": "src/.well-known",
    "output": "/.well-known"
  }
]

5. Rebuild your project.

iOS Universal Links

1. Create a /src/.well-known directory in your project's src directory.

2. Inside the /src/.well-known directory, create a file named apple-app-site-association

3. In the apple-app-site-association file, add the following code to it:

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "TEAM_ID.BUNDLE_ID",
        "paths": ["*"]
      }
    ]
  }
}

Replace TEAM_ID.BUNDLE_ID with your app's Team ID and Bundle ID.

4. Add the /src/.well-known directory to the assets array in your angular.json file.

"assets": [
  "src/favicon.ico",
  "src/assets",
  {
    "glob": "**/*",
    "input": "src/.well-known",
    "output": "/.well-known"
  }
]

5. Rebuild your project.

After following these steps, your Angular app should be set up to handle deep links on both Android and iOS devices.

For more information: https://capacitorjs.com/docs/guides/deep-links

Firebase Messaging Service Worker

In your project, you need to create a file named src/firebase-messaging-sw.js. This file will be responsible for handling Firebase messaging in the service worker.

Here's a breakdown of the code in this file:

// Give the service worker access to Firebase Messaging.
// Note that you can only use Firebase Messaging here. Other Firebase libraries
// are not available in the service worker.
importScripts("https://www.gstatic.com/firebasejs/8.10.1/firebase-app.js");
importScripts("https://www.gstatic.com/firebasejs/8.10.1/firebase-messaging.js");

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
const firebaseApp = initializeApp({
  apiKey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  authDomain: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  projectId: "xxxxxxxxxxxxxxxxxx",
  storageBucket: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  messagingSenderId: "xxxxxxxxxxxx",
  appId: "x:xxxxxxxxxxxx:web:xxxxxxxxxxxxxxxxxxxx",
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = firebase.messaging();

This code initializes your Firebase application with your Firebase configuration. Replace the "xxxxxxx" with your actual Firebase configuration values.

This line retrieves an instance of Firebase Messaging so that it can handle background messages.

Contributing

We welcome contributions to the project! For detailed instructions on how to contribute, please refer to the CONTRIBUTING.md file.

Security

Paths

• android/app/google-services.json

• ios/App/App/GoogleService-info.plist

Google Services

GoogleService-info.plist and google-services.json

google-services.json is a configuration file that contains information about a Firebase project, such as the project's API key, database URL, and storage bucket. It is used by Android apps to connect to Firebase services, such as Firebase Authentication, Firebase Realtime Database, and Firebase Cloud Messaging.

The content of the Firebase config or object can be considered as public, including the app's platform-specific ID (Apple bundle ID or Android package name) and the Firebase project-specific values, like the API Key, project ID, Realtime Database URL, and Cloud Storage bucket name. Given this, use Firebase Security Rules to protect your data and files in Realtime Database, Cloud Firestore, and Cloud Storage.

GoogleService-info.plist is a configuration file that contains information about a Firebase project, such as the project's API key, database URL, and storage bucket. It is used by iOS apps to connect to Firebase services, such as Firebase Authentication, Firebase Realtime Database, and Firebase Cloud Messaging.

To secure the GoogleService-info.plist file, you can ensure that it is not publicly accessible. This can be done by adding the file to your app's .gitignore file to prevent it from being committed to your repository. Additionally, you can use Firebase Security Rules to restrict access to your Firebase project's resources, such as the Realtime Database and Cloud Storage, to only authorized users.

It is also important to keep your Firebase project's API key and other sensitive information secure. You can use a password manager to securely store your API key and other credentials, and avoid hardcoding them in your app's code.

For more information on how to secure your Firebase project, please refer to the following resources:

• Config Files Objects

Stats

Stargazers

Contributors

License

This project is licensed under the BSD-3-Clause License - see the LICENSE file for details.