fox-send/README.md

# [![Firefox Send](./assets/logo.svg)](https://send.firefox.com/)

[![CircleCI](https://img.shields.io/circleci/project/github/mozilla/send.svg)](https://circleci.com/gh/mozilla/send)

**Docs:** [FAQ](docs/faq.md), [Encryption](docs/encryption.md), [Build](docs/build.md), [Docker](docs/docker.md), [Metrics](docs/metrics.md), [More](docs/)

---

## Table of Contents

* [What it does](#what-it-does)
* [Requirements](#requirements)
* [Development](#development)
* [Commands](#commands)
* [Configuration](#configuration)
* [Localization](#localization)
* [Contributing](#contributing)
* [Testing](#testing)
* [Deployment](#deployment)
* [Android](#android)
* [License](#license)

---

## What it does

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

---

## Requirements

- [Node.js 10.x](https://nodejs.org/)
- [Redis server](https://redis.io/) (optional for development)
- [AWS S3](https://aws.amazon.com/s3/) or compatible service. (optional)

---

## Development

To start an ephemeral development server run:

```sh
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](server/config.js) for all options and [docs/docker.md](docs/docker.md) for examples.

---

## Localization

Firefox Send localization is managed via [Pontoon](https://pontoon.mozilla.org/projects/test-pilot-firefox-send/), 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](https://pontoon.mozilla.org/teams/) for your language or Mozilla’s [l10n-drivers](https://wiki.mozilla.org/L10n:Mozilla_Team#Mozilla_Corporation) for guidance.

see also [docs/localization.md](docs/localization.md)

---

## Contributing

Pull requests are always welcome! Feel free to check out the list of ["good first issues"](https://github.com/mozilla/send/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

---

## Testing

| ENVIRONMENT | URL
|-------------|-----
| Production  | <https://send.firefox.com/>
| Stage       | <https://stage.send.nonprod.cloudops.mozgcp.net/>
| Development | <https://send2.dev.lcip.org/>

---

## Deployment

see also [docs/deployment.md](docs/deployment.md)

---

## 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](LICENSE)

---
-												Replace title with Firefox Send logo
											
										
										
											2019-03-30 14:47:34 +00:00
+								# [![Firefox Send](./assets/logo.svg)](https://send.firefox.com/)
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												Adds 'Available on Test Pilot' badge.

Also changes the style of the CircleCI badge to match.
											
										
										
											2017-07-20 15:08:13 +00:00
+								[![CircleCI](https://img.shields.io/circleci/project/github/mozilla/send.svg)](https://circleci.com/gh/mozilla/send)
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												updated docs

											
										
										
											2018-03-06 00:29:09 +00:00
+								**Docs:** [FAQ](docs/faq.md), [Encryption](docs/encryption.md), [Build](docs/build.md), [Docker](docs/docker.md), [Metrics](docs/metrics.md), [More](docs/)
-												Adds metrics documentation (closes #5).

											
										
										
											2017-07-14 20:20:28 +00:00
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												introducing ToC to README.md

**this PR does basically aim at:**
- *introducing ToC to README.md file*
											
										
										
											2017-10-06 19:03:14 +00:00
 								## Table of Contents
 								* [What it does](#what-it-does)
 								* [Requirements](#requirements)
 								* [Development](#development)
 								* [Commands](#commands)
 								* [Configuration](#configuration)
 								* [Localization](#localization)
 								* [Contributing](#contributing)
 								* [Testing](#testing)
-												Add deployment instructions (#1366)


											
										
										
											2019-07-12 14:07:24 +00:00
+								* [Deployment](#deployment)
-												Add a small blurb describing how to test the android version.

											
										
										
											2018-09-19 14:19:18 +00:00
+								* [Android](#android)
-												introducing ToC to README.md

**this PR does basically aim at:**
- *introducing ToC to README.md file*
											
										
										
											2017-10-06 19:03:14 +00:00
+								* [License](#license)
 								---
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
+								## What it does
-												remove P2P references.  Fixes #224

											
										
										
											2017-07-19 16:23:42 +00:00
+								A file sharing experiment which allows you to send encrypted files to other users.
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
+								## Requirements
-												task: update engines in package.json and README to clarify that node 10.x is expected

											
										
										
											2019-09-19 17:37:05 +00:00
+								- [Node.js 10.x](https://nodejs.org/)
-												updated readme. made redis optional in dev

											
										
										
											2017-08-25 20:58:51 +00:00
+								- [Redis server](https://redis.io/) (optional for development)
 								- [AWS S3](https://aws.amazon.com/s3/) or compatible service. (optional)
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												updated readme. made redis optional in dev

											
										
										
											2017-08-25 20:58:51 +00:00
+								---
 								## Development
 								To start an ephemeral development server run:
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
 								```sh
-												updated readme. made redis optional in dev

											
										
										
											2017-08-25 20:58:51 +00:00
+								npm install
 								npm start
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
+								```
-												added local dev url to readme

											
										
										
											2017-08-25 22:41:53 +00:00
+								Then browse to http://localhost:8080
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												updated readme. made redis optional in dev

											
										
										
											2017-08-25 20:58:51 +00:00
+								## Commands
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
 								| 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.
-												a few changes to make A/B testing easier

											
										
										
											2017-08-24 21:54:02 +00:00
+								| `npm start`      | Runs the server in development configuration.
 								| `npm run build`  | Builds the production assets.
 								| `npm run prod`   | Runs the server in production configuration.
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												updated readme. made redis optional in dev

											
										
										
											2017-08-25 20:58:51 +00:00
+								## Configuration
-												fix docker link typo
											
										
										
											2017-08-27 20:45:38 +00:00
+								The server is configured with environment variables. See [server/config.js](server/config.js) for all options and [docs/docker.md](docs/docker.md) for examples.
-												updated readme. made redis optional in dev

											
										
										
											2017-08-25 20:58:51 +00:00
 								---
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
+								## Localization
-												[Docs] - README.md - minor spelling fixes

[Docs] - README.md - minor spelling fixes
											
										
										
											2017-12-21 15:35:44 +00:00
+								Firefox Send localization is managed via [Pontoon](https://pontoon.mozilla.org/projects/test-pilot-firefox-send/), 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](https://pontoon.mozilla.org/teams/) for your language or Mozilla’s [l10n-drivers](https://wiki.mozilla.org/L10n:Mozilla_Team#Mozilla_Corporation) for guidance.
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												updated docs

											
										
										
											2018-03-06 00:29:09 +00:00
+								see also [docs/localization.md](docs/localization.md)
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
+								## Contributing
-												README: Fix query link for "good first bugs"

											
										
										
											2017-12-31 11:09:57 +00:00
+								Pull requests are always welcome! Feel free to check out the list of ["good first issues"](https://github.com/mozilla/send/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												Fix dev server URL in README.md file

											
										
										
											2017-07-05 16:47:22 +00:00
+								## Testing
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												Fix dev server URL in README.md file

											
										
										
											2017-07-05 16:47:22 +00:00
+								| ENVIRONMENT | URL
 								|-------------|-----
-												Change README.md server URLs to send.*

											
										
										
											2017-07-06 19:12:01 +00:00
+								| Production  | <https://send.firefox.com/>
-												updated readme environment urls. closes #1161

											
										
										
											2019-03-08 01:03:50 +00:00
+								| Stage       | <https://stage.send.nonprod.cloudops.mozgcp.net/>
 								| Development | <https://send2.dev.lcip.org/>
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
+								---
-												Add deployment instructions (#1366)


											
										
										
											2019-07-12 14:07:24 +00:00
+								## Deployment
 								see also [docs/deployment.md](docs/deployment.md)
 								---
-												Add a small blurb describing how to test the android version.

											
										
										
											2018-09-19 14:19:18 +00:00
+								## 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.
 								---
-												Update README with some more details

											
										
										
											2017-06-26 19:34:31 +00:00
+								## License
 								[Mozilla Public License Version 2.0](LICENSE)
-												adding separators to README

**in this PR I did basically:**

- *add separators to README file*

---

**I did this because:**

- *i feel it improves the overall flow of the file*
											
										
										
											2017-08-20 12:05:48 +00:00
 								---