54e78b6274
test_upload: This will create a file and make sure it uploads by verifying a file uploads and is assigned a URL.
test_download: This will create a file, upload it and then download it making sure it is the same filename that was uploaded. We can expand this later to maybe check the sizes and such.
test_progress: This will create a file and make sure the progress bar shows up after it begins uploading.
These are python tests and use Pipenv to manage dependencies as well as tox as the virtualenv manager, and finally pytest as the test runner.
|
||
|---|---|---|
| app | ||
| assets | ||
| build | ||
| common | ||
| docs | ||
| public | ||
| scripts | ||
| server | ||
| test | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.yml | ||
| .gitattributes | ||
| .gitignore | ||
| .htmllintrc | ||
| .prettierignore | ||
| .stylelintrc | ||
| CHANGELOG.md | ||
| CONTRIBUTORS | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| browserconfig.xml | ||
| browserslist | ||
| circle.yml | ||
| docker-compose.yml | ||
| l10n.toml | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| webpack.config.js | ||
README.md
Firefox Send
Docs: FAQ, Encryption, Build, Docker, Metrics, More
Table of Contents
- What it does
- Requirements
- Development
- Commands
- Configuration
- Localization
- Contributing
- Testing
- License
What it does
A file sharing experiment which allows you to send encrypted files to other users.
Requirements
- Node.js 8.2+
- Redis server (optional for development)
- AWS S3 or compatible service. (optional)
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 Mozilla’s 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/ |
License
Mozilla Public License Version 2.0