Go to file
Danny Coates 01105a0a98
Merge pull request #1091 from mozilla/add-new-metrics
add new metrics md
2019-01-17 11:30:37 -08:00
.vscode got webpack production mode running 2018-07-13 11:13:09 -07:00
android typo. fixes #1100 2019-01-16 14:19:33 -08:00
app restored accidentally deleted style 2019-01-16 16:18:23 -08:00
assets Fix #888 Implement share card. 2019-01-16 12:05:39 -05:00
build reimplemented l10n using dynamic import() (#1012) 2018-11-20 09:50:59 -05:00
common reimplemented l10n using dynamic import() (#1012) 2018-11-20 09:50:59 -05:00
docs add new metrics md 2019-01-11 18:37:01 +01:00
ios renamed fileManager.js to controller.js 2018-11-08 15:12:07 -08:00
public changed upload button label 2018-12-11 15:11:38 -08:00
scripts a few changes to make A/B testing easier 2017-08-25 09:44:52 -07:00
server removed /download from android routes in dev.js since it has no ui 2019-01-10 15:00:03 -08:00
test use custom elements instead of adding css classes for selectors 2019-01-10 16:22:40 -08:00
.dockerignore reimplemented l10n using dynamic import() (#1012) 2018-11-20 09:50:59 -05:00
.editorconfig added editorconfig 2017-08-11 11:39:56 +09:00
.eslintignore load cryptofill.js async 2018-11-26 10:36:49 -08:00
.eslintrc.yml updated deps 2018-11-02 16:07:26 -07:00
.gitattributes fixed .gitattributes locale dir 2017-08-02 23:02:50 -07:00
.gitignore converting some things to choo/component 2018-11-15 15:43:32 -08:00
.htmllintrc Add basic htmllint config 2017-06-09 10:25:15 -07:00
.prettierignore load cryptofill.js async 2018-11-26 10:36:49 -08:00
.stylelintrc a new approach for the ui 2018-11-01 10:43:43 -07:00
CHANGELOG.md v2.5.3 2018-03-29 00:03:04 -07:00
CONTRIBUTORS v2.5.3 2018-03-29 00:03:04 -07:00
Dockerfile Upgrade to Node v10 2019-01-07 15:50:01 -05:00
LICENSE Add LICENSE file 2017-06-23 11:56:02 -07:00
README.md Add a small blurb describing how to test the android version. 2018-09-19 10:19:18 -04:00
browserconfig.xml Change Favicon in to look better in a variety of cases 2017-10-06 11:24:17 -04:00
browserslist updated browserlist 2018-03-01 14:52:00 -08:00
circle.yml wip 2018-11-01 10:43:14 -07:00
docker-compose.yml Added webdriverio integration tests 2018-10-03 11:22:30 -07:00
l10n.toml added toml file 2017-07-21 10:39:41 -07:00
package-lock.json updated deps 2019-01-16 16:18:50 -08:00
package.json updated deps 2019-01-16 16:18:50 -08:00
postcss.config.js a couple android ui tweaks 2018-11-14 21:13:38 -08:00
tailwind.js a few style tweaks 2018-11-02 11:28:56 -07:00
webpack.config.js load cryptofill.js async 2018-11-26 10:36:49 -08:00

README.md

Firefox Send

BrowserStack Status CircleCI Available on Test Pilot

Docs: FAQ, Encryption, Build, Docker, Metrics, More


Table of Contents


What it does

A file sharing experiment which allows you to send encrypted files to other users.


Requirements


Development

To start an ephemeral development server run:

npm install
npm start

Then browse to http://localhost:8080


Commands

Command Description
npm run format Formats the frontend and server code using prettier.
npm run lint Lints the CSS and JavaScript code.
npm test Runs the suite of mocha tests.
npm start Runs the server in development configuration.
npm run build Builds the production assets.
npm run prod Runs the server in production configuration.

Configuration

The server is configured with environment variables. See server/config.js for all options and docs/docker.md for examples.


Localization

Firefox Send localization is managed via Pontoon, not direct pull requests to the repository. If you want to fix a typo, add a new language, or simply know more about localization, please get in touch with the existing localization team for your language or Mozillas l10n-drivers for guidance.

see also docs/localization.md


Contributing

Pull requests are always welcome! Feel free to check out the list of "good first issues".


Testing

ENVIRONMENT URL
Production https://send.firefox.com/
Stage https://send.stage.mozaws.net/
Development https://send.dev.mozaws.net/

Android

The android implementation is contained in the android directory, and can be viewed locally for easy testing and editing by running ANDROID=1 npm start and then visiting http://localhost:8080. CSS and image files are located in the android/app/src/main/assets directory.


License

Mozilla Public License Version 2.0