Skip to content
This repository has been archived by the owner on Sep 7, 2024. It is now read-only.

Latest commit

 

History

History
96 lines (52 loc) · 4.1 KB

FEATURES.md

File metadata and controls

96 lines (52 loc) · 4.1 KB

Features

This document contains all working features and assumes you have a development version of the project setup for testing.

Internationaliztion(i18n)

We now support two languages Enlish and French. Users can select their prefered language by using toggles on the navbars and footers

Sign Up

Register for an SMSWithoutBorders account by filling the form on the signup page. This is a two step process involving two factor (2fa) authentication of the phone number provided. On successfull submission, you will be redirected to the verification page to provide the authentication code. Once verified, your account will be created.

signup

The signup page url accepts an optional parameter ari to identify users who chose to signup from the mobile app. The value of this parameter is an intent url which the user will be redirected to after two factor authentication is complete

Login

Login to access your account using the credentials created at signup.

login

Token storage

Authenticated users can access the wallet page to save tokens for all supported platforms(Gmail, X and Telegram). Each platform's token can be saved by clicking the save button under its description

wallet

When saving tokens for Gmail and X, an authorization screen will be displayed prompting you to grant the requested permissions.

wallet wallet

Saving Telegram access requires a phone number to be provided. A verification code will be sent which you have to provide to confirm. If you do not already have a Telegram account you will be prompted to create one.

Telegram;

Token Revoke

Authenticated users can delete stored tokens by selecting the revoke button under saved platform's details.

Token revoke;

Password Change

Authenticated users can change their current password from settings

Password change;

Password Recovery

Users who have forgotten their account password can recover it by clicking the forgot password link on the login page. The phone number associated with the account is to be provided to which an authentication code will be sent for verification.

Password Recovery Step 1;

After the code is successfully verified, the user will be able to set a new password

Password Recovery Step 2;

After setting a new password, The user can resume using their account

Password Recovery Step 3;

Account Deletion

Authenticated users can delete their accounts from the settings page under the account deletion tab

Account Deletion;

User Dashboard

Authenticated users can access their dashboard

Dashboard;

Rendering Markdown Files

The Privacy Policy page is loaded from the privacy-policy folder as markdown into the website. Check CONFIGURATIONS.md on how to setup the file path.

The website then determines which file to load based on the currently selected locale.

 /path_to_privacy_policy_files/{locale}.md

Synchronization

Authenticated users can synchronize their accounts with the mobile app from the Synchronization page. This process ensures users can communicate securely over sms through the app.

The sync page uses a background socket connection to enable handshakes. The intial request to obtain the connection url returns a JSON object with two keys

{
 "qr_url": "",
 "mobile_url": "",
}