fox-send/README.md

51 lines
1.4 KiB
Markdown
Raw Normal View History

2017-07-11 19:34:49 +00:00
# Firefox Send
2017-06-26 19:34:31 +00:00
2017-07-11 19:34:49 +00:00
[![CircleCI](https://circleci.com/gh/mozilla/send.svg?style=svg)](https://circleci.com/gh/mozilla/send)
2017-06-26 19:34:31 +00:00
**Docs:** [Docker](docs/docker.md), [Metrics](docs/metrics.md)
2017-06-26 19:34:31 +00:00
## What it does
A P2P file sharing experiment which allows you to send encrypted files to other users.
## Requirements
- [Node.js 8+](https://nodejs.org/)
- [Redis server](https://redis.io/)
2017-07-05 16:47:22 +00:00
**NOTE:** To run the project, make sure you have a Redis server running locally:
2017-06-26 19:34:31 +00:00
```sh
$ redis-server /usr/local/etc/redis.conf
```
## How to use it
| Command | Description |
|------------------|-------------|
| `npm run dev` | Builds and starts the web server locally for development.
| `npm run format` | Formats the frontend and server code using **prettier**.
| `npm run lint` | Lints the CSS and JavaScript code.
| `npm start` | Starts the Express web server.
| `npm test` | Runs the suite of mocha tests.
## Localization
2017-07-11 19:34:49 +00:00
_Coming soon_ (see [#57](https://github.com/mozilla/send/issues/57))
2017-06-26 19:34:31 +00:00
## Contributing
2017-07-11 19:34:49 +00:00
Pull requests are always welcome! Feel free to check out the list of ["good first bugs"](https://github.com/mozilla/send/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+bug%22).
2017-06-26 19:34:31 +00:00
2017-07-05 16:47:22 +00:00
## Testing
2017-06-26 19:34:31 +00:00
2017-07-05 16:47:22 +00:00
| ENVIRONMENT | URL
|-------------|-----
2017-07-06 19:12:01 +00:00
| Production | <https://send.firefox.com/>
| Stage | <https://send.stage.mozaws.net/>
| Development | <https://send.dev.mozaws.net/>
2017-06-26 19:34:31 +00:00
## License
[Mozilla Public License Version 2.0](LICENSE)