Dis moi means Tell me in 🇫🇷 French.
Dismoi is a web extension that allows anyone to post information directly on any web page you browse. If you follow an informer, his messages are displayed at the time you visit the pages he has commented on.
To learn more about the uses cases, visit the 🇫🇷 Dismoi website.
At the time of writing, information are stored in database and exposed via the Dismoi Backend.
You can find the latest tests version of Dismoi extension on the releases page.
For the latest production version of Dismoi extension visit the official addon page of you favorite browser:
To the attention of the Mozilla addon reviewer.
To reach zero diff with the submitted addon, the addon must be build with node version
10.15.0
.yarn install && NODE_ENV=production yarn build:firefox
Or just run the build process with
Docker
:yarn build:firefox:production:docker
https://extensionworkshop.com/documentation/publish/source-code-submission/
The Dismoi extension requires the following permissions :
activeTab
The extension is able to follow your navigation on the active tab, when you browse to a newURL
you may receive a new information.storage
The extension use thesync
storage area to store and sync across browser instance the following informations :prefs
The contributions you dismissed, disliked, liked, read. Also if you accepted the 🇫🇷 Term of Service.subscriptions
Which informers you are following.installationDetails
The extension version, date of installation, date of last update.user
A generated unique identifier.serviceMessage
The last time you saw the service message, to avoid showing it up again.
matches: ['*://*/*']
To potentially notify you on any page you are visiting.In the near future we wan't to use the declarative content API, to avoid injecting Js everywhere and further protect your private life (see #275).
- Clone the repository
git clone git@github.com:dis-moi/extension.git dismoi-extension
- Install yarn
- Install dependencies
yarn
To start the
profiles
app in development run the following commandyarn start:profiles
- Create a copy of
.env.development.example
to.env.development
and adjust the values.
Read further on environments.
- Start the extension
yarn start
Watch files changes (but do not reload the content script though)
- Open chrome://extensions/,
- activate Developer mode
- click Load unpacked
- and load
build/development/chromium
folder
Chrom(e|ium) browser is recommend for development. see https://developer.chrome.com/extensions/getstarted#manifest
You’re welcome to help!
For further reading, refer to the Dismoi contributing guidelines.
# test everything
yarn test
For integration tests see #289
There is a Storybook for Dismoi components design, exploration, testing and documentation. It's hot reloaded. Storybook may be run with the following command:
yarn storybook
It also possible to build a static version, the one you can see here : https://storybook.lmem.net.
You can do this with:
yarn build-storybook
It is automatically deployed to https://storybook.lmem.net on every develop
branch update.
- 🌐 Web: https://www.dismoi.io
- 🐦 Twitter: https://twitter.com/DisMoiCompagnon
Copyright (C) 2016-2024 ALTERNATIVES NGO
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU AFFERO GENERAL PUBLIC LICENSE for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.