SimpleLogin is the open-source privacy-first email alias and Single Sign-On (SSO) Identity Provider.
More info on our website at https://simplelogin.io
The extension uses VueJS with https://github.com/Kocal/vue-web-extension boilerplate.
The extension consists of 3 main screens:
- setup screen for first-time user. Here user can create and paste the
API Key
that's stored inchrome.storage
. - main screen: displays email alias recommendation, alias creation and existing alias.
- new alias screen: when a new alias is created, user is redirected to this screen so they can copy it.
All work on SimpleLogin Chrome/Firefox extension happens directly on GitHub.
To run the extension locally, please follow these steps:
-
install all dependencies with
npm install
. -
run
npm start
to generate the/dist
folder that can be installed into Chrome.
On Firefox, it can be done via web-ext
tool from within the /dist
folder:
( cd dist/ ; web-ext run )
The code is formatted using prettier
, make sure to run it before creating the commit:
npm run prettier:write
- Increment the version in
package.json
- Update CHANGELOG with the changes
- Build the production version and zip it via
npm run build && npm run build-zip
- (Optional, only useful for beta build) Build beta version: change
betaRev
inpackage.json
, then generate zip file using
npm run build:beta && npm run build-zip
- Upload to Chrome, Firefox, Edge stores.