/Liberty-Arrow-backend

A serverless backend to provide server-side functionality for the Liberty Arrow browser extension.

Primary LanguageHTMLCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Liberty Arrow Backend

badge-lastcommit badge-openissues badge-license badge-contributors badge-codesize

What is Liberty Arrow Backend?

Liberty Arrow Backend is the backend server for Liberty Arrow. It handles processes such as sending confirmation emails.

Dependencies

Development

  • Python 3
  • PIP

Platforms

  • API

Motivation

I wanted to include new features in Liberty Arrow, but they required to have server-side functionality. This is why I created this project as the extension's backend.

Installation and usage

  1. Install dependencies:
    • You can find the latest version of Python 3 and PIP here.
  2. Setup an email for testing:
    1. Go to Google Account and setup 2 factor authentication (2FA) if you do not have one (required for next step).
    2. In Google Account, create an application password for Liberty Arrow Backend (you will only have this option if you have 2FA enabled).
    3. Add your email and application password as the GMAIL_USERNAME and GMAIL_APP_PASSWORD environment variables, respectively.
  3. Run the project:
    1. Fork the repository in GitHub.
    2. Go to your fork and copy the link to clone your repository.
    3. Go to Git in your local machine and use the command git clone (your link).
    4. Run index.py.

Contributors

Thanks to these wonderful people for making Liberty Arrow Backend possible!

License

This work is licensed under a Creative Commons Attribution 4.0 International License.