fox-send/README.md

1.7 KiB

Firefox Send

CircleCI

Docs: Docker, Metrics

What it does

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

Requirements

NOTE: To run the project, make sure you have a Redis server running locally:

$ 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

Coming soon (see #57)

Contributing

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

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

Entypo

Copyright (C) 2012 by Daniel Bruce

Author: Daniel Bruce License: SIL (http://scripts.sil.org/OFL) Homepage: http://www.entypo.com

Font Awesome

Copyright (C) 2016 by Dave Gandy

Author: Dave Gandy License: SIL () Homepage: http://fortawesome.github.com/Font-Awesome/