natty
/
fox-send
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fox-send/README.md

68 lines
2.0 KiB
Markdown
Raw Normal View History

rename to 'send'
2017-07-11 19:34:49 +00:00
# Firefox Send
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)
[![Available on Test Pilot](https://img.shields.io/badge/available_on-Test_Pilot-0996F8.svg)](https://testpilot.firefox.com/experiments/send)
Update README with some more details
2017-06-26 19:34:31 +00:00
Adds metrics documentation (closes #5).
2017-07-14 20:20:28 +00:00
**Docs:** [Docker](docs/docker.md), [Metrics](docs/metrics.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
## 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
Fixed minimum NodeJS version NodeJS version was increased due to http header splitting vulnerability
2017-08-24 19:00:28 +00:00
- [Node.js 8.2+](https://nodejs.org/)
Update README with some more details
2017-06-26 19:34:31 +00:00
- [Redis server](https://redis.io/)
Fix dev server URL in README.md file
2017-07-05 16:47:22 +00:00
**NOTE:** To run the project, make sure you have a Redis server running locally:
Update README with some more details
2017-06-26 19:34:31 +00:00
```sh
$ redis-server /usr/local/etc/redis.conf
```
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
## 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.
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
## Localization
Update README text w/ guidance from flod
2017-08-02 04:51:19 +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
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
rename to 'send'
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).
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/>
| Stage | <https://send.stage.mozaws.net/>
| Development | <https://send.dev.mozaws.net/>
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
## 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
---